Mdoc – markdown code documentation system • Hacker News Board

Mdoc – markdown code documentation system

#1

Post by chutsu » Fri, Apr 18, 2014, 9:37 PM UTC

I created a markdown documentation system similar to Flatdoc, but has a layout similar to Backbone.js and Three.js's API documentation. Just wanted some feedback to see if this is something people would use? :)

Mdoc – markdown code documentation system
chutsu.github.io

Re: Mdoc – markdown code documentation system

#2

Post by jotux » Fri, Apr 18, 2014, 10:41 PM UTC

An example of documentation generated from mdoc would be nice.

Re: Mdoc – markdown code documentation system

#3

Post by chutsu » Sat, Apr 19, 2014, 12:03 AM UTC

jotux wrote: post #2

An example of documentation generated from mdoc would be nice.

What you see in that link is* the generated doc. You set links in sidebar.md to docs you want to show, and when you click on it, it GETs the markdown file and renders it in the #content div.

Have a look here for another example of mdoc in action: http://chutsu.github.io/playground/

Re: Mdoc – markdown code documentation system

#4

Post by jotux » Sat, Apr 19, 2014, 9:30 PM UTC

chutsu wrote: post #3

jotux wrote: post #2

An example of documentation generated from mdoc would be nice.

What you see in that link is* the generated doc. You set links in sidebar.md to docs you want to show, and when you click on it, it GETs the markdown file and renders it in the #content div. Have a look here for another example of mdoc in action: http://chutsu.github.io/playground/

Seems to be a dead link.