inline docs aren't a good idea. know what's a good idea? inline ghm.

a-idea.markdown

/** @render-ghm

render-ghm.js

meta

@author devinrhode2 (devinrhode2@gmail.com)

-> Pause. Actually.. the author is all handled by git.

-> I see inline docs as a super easy to do documentation. With this idea, literally docs are one in the same as your project directory. You browse the documentation by browsing the project source.

Whenever a /** @render-ghm */ comment starts a file, that contents is render in GHM when viewed in github's awesome source browser.

It's pretty simple.. let me know if you don't get it or anything.

*/

idea.js

//the source of the above markdown.
/** @render-ghm

### render-ghm.js
_meta_

@author devinrhode2 (devinrhode2@gmail.com)
-> Pause. Actually.. the author is all handled by git.
-> I see inline docs as a super easy to do documentation. With this idea, literally docs are one in the same as your project directory. You browse the documentation by browsing the project source.

Whenever a /** @render-ghm */ comment starts a file, that contents is render in GHM when viewed in github's awesome source browser.

It's pretty simple.. let me know if you don't get it or anything.

*/