search

rcorp / standard-project-structure

A mission to improve developer productivity. Automate Everything ™ !
Apache License 2.0
5 stars 3 forks source link

Documentation #9

Open gaurav21r opened 8 years ago

gaurav21r commented 8 years ago

I think we should cater to 3 different types of documentation:

  1. API Docs with JSDoc style tagging @param, @method etc.
  2. Inline Code Documentation. This trend was really started by Litrerate CofeeScript and docco
  3. Plain markdown files converting to HTML. This will intersect with Static Site Generation as well.
gaurav21r commented 8 years ago

cc @riteshe63 @prakash1517 @nitinmadeshia @divya3103

gaurav21r commented 8 years ago

Some of our options:

  1. https://github.com/jbt/docker
  2. https://github.com/tj/dox
  3. https://github.com/jsdoc3/jsdoc
  4. https://github.com/jashkenas/docco
  5. https://github.com/mr-doc/mr-doc

Some resources:

@riteshe63 Please suggest a complete soultion using one or more of the above that would work for JS / TS / CS / MD

All The Best :+1: :yum:

riteshe63 commented 8 years ago

@gaurav21r This option is better: https://github.com/jsdoc3/jsdoc