Awesome
This repo demonstrates how markdown-autodocs works. View the raw README.md file to see the comments needed for markdown-autodocs to, well, do it's auto documentation.
Code block
<!-- MARKDOWN-AUTO-DOCS:START (CODE:src=./code-that-i-want-in-readme.js) -->
<!-- The below code snippet is automatically added from ./code-that-i-want-in-readme.js -->
alert('This code is automatically added to .md')
alert('awesome!')
<!-- MARKDOWN-AUTO-DOCS:END -->
JSON to HTML table
<!-- MARKDOWN-AUTO-DOCS:START (JSON_TO_HTML_TABLE:src=./json-that-i-want-in-readme-as-a-table.json) -->
<table class="JSON-TO-HTML-TABLE"><thead><tr><th class="organization-th">Organization</th><th class="project-th">Project</th><th class="website-th">Website</th><th class="license-th">License</th></tr></thead><tbody ><tr ><td class="organization-td td_text">Google</td><td class="project-td td_text">https://github.com/kubernetes/kubernetes</td><td class="website-td td_text">https://kubernetes.io/</td><td class="license-td td_text">Apache-2.0 License</td></tr>
<tr ><td class="organization-td td_text">Facebook</td><td class="project-td td_text">https://github.com/facebook/react</td><td class="website-td td_text">https://reactjs.org/</td><td class="license-td td_text">MIT License</td></tr>
<tr ><td class="organization-td td_text">Elasticsearch</td><td class="project-td td_text">https://github.com/elastic/elasticsearch</td><td class="website-td td_text">https://www.elastic.co/</td><td class="license-td td_text">Elastic License 2.0</td></tr>
<tr ><td class="organization-td td_text">Redhat</td><td class="project-td td_text">https://github.com/openshift/origin</td><td class="website-td td_text">http://www.openshift.org/</td><td class="license-td td_text">Apache-2.0 License</td></tr>
<tr ><td class="organization-td td_text">HashiCorp</td><td class="project-td td_text">https://www.terraform.io/</td><td class="website-td td_text">https://github.com/hashicorp/terraform</td><td class="license-td td_text">MPL-2.0 License</td></tr></tbody></table>
<!-- MARKDOWN-AUTO-DOCS:END -->
Github Workflow Artifacts table
<!-- MARKDOWN-AUTO-DOCS:START (WORKFLOW_ARTIFACT_TABLE) -->
<table class="ARTIFACTS-TABLE"><thead><tr><th class="artifact-th">Artifact</th><th class="workflow-th">Workflow</th></tr></thead><tbody ><tr ><td class="artifact-td td_text"><a href=https://github.com/dineshsonachalam/repo-using-markdown-autodocs/suites/8127896535/artifacts/352061364>Dummy-file-1</a></td><td class="workflow-td td_text"><a href=https://github.com/dineshsonachalam/repo-using-markdown-autodocs/actions/runs/2988868978>generate-artifacts</a></td></tr>
<tr ><td class="artifact-td td_text"><a href=https://github.com/dineshsonachalam/repo-using-markdown-autodocs/suites/8127896535/artifacts/352061365>Dummy-file-2</a></td><td class="workflow-td td_text"><a href=https://github.com/dineshsonachalam/repo-using-markdown-autodocs/actions/runs/2988868978>generate-artifacts</a></td></tr>
<tr ><td class="artifact-td td_text"><a href=https://github.com/dineshsonachalam/repo-using-markdown-autodocs/suites/8127896535/artifacts/352061366>Dummy-file-3</a></td><td class="workflow-td td_text"><a href=https://github.com/dineshsonachalam/repo-using-markdown-autodocs/actions/runs/2988868978>generate-artifacts</a></td></tr>
<tr ><td class="artifact-td td_text"><a href=https://github.com/dineshsonachalam/repo-using-markdown-autodocs/suites/8127896535/artifacts/352061367>Dummy-file-4</a></td><td class="workflow-td td_text"><a href=https://github.com/dineshsonachalam/repo-using-markdown-autodocs/actions/runs/2988868978>generate-artifacts</a></td></tr>
<tr ><td class="artifact-td td_text"><a href=https://github.com/dineshsonachalam/repo-using-markdown-autodocs/suites/8127896535/artifacts/352061368>Dummy-file-5</a></td><td class="workflow-td td_text"><a href=https://github.com/dineshsonachalam/repo-using-markdown-autodocs/actions/runs/2988868978>generate-artifacts</a></td></tr></tbody></table>
<!-- MARKDOWN-AUTO-DOCS:END -->