sysbender / repo-using-markdown-autodocs

Example Repo for markdown-autodocs

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.

my code

console.log('Hello World!');
console.log('new line');

Example: nice looking table to compare code changes

Before	After
console.log('Hello World!'); console.log('new line');	print('hello world!') print('new line')

Code block

alert('This code is automatically added to .md')
alert('awesome!')

JSON to HTML table

Organization	Project	Website	License
Google	https://github.com/kubernetes/kubernetes	https://kubernetes.io/	Apache-2.0 License
Facebook	https://github.com/facebook/react	https://reactjs.org/	MIT License
Elasticsearch	https://github.com/elastic/elasticsearch	https://www.elastic.co/	Elastic License 2.0
Redhat	https://github.com/openshift/origin	http://www.openshift.org/	Apache-2.0 License
HashiCorp	https://www.terraform.io/	https://github.com/hashicorp/terraform	MPL-2.0 License

Github Workflow Artifacts table

Artifact	Workflow
Dummy-file-1	generate-artifacts
Dummy-file-2	generate-artifacts
Dummy-file-3	generate-artifacts
Dummy-file-4	generate-artifacts
Dummy-file-5	generate-artifacts

Code	Comment
{% highlight cpp %}int x = 3;{% endhighlight %}	{% highlight javascript %} {% include_relative hello.js %} {% endhighlight %} </td>