An Ember.js driven, YUIDoc parsed, documentation module.
JavaScript CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
node_configs
scripts
styles
templates
vendor
.gitignore
.jshintrc
Gruntfile.js
index.html
package.json
readme.md
todo.md

readme.md

em-docs v0.0.1-0

An Ember.js driven, YUIDoc parsed, documentation module.

Warning: Very early and very rough with absolutely zero testing.

Requires

Setting it up in a project

  1. cd into the root of your project directory
  2. git clone git@github.com:amsul/em-docs.git docs
  3. Configure grunt-contrib-yuidoc for your own project
  4. Point the outdir to docs/scripts-docs/ and set parseOnly to true
  5. Create a static server in your root directory. Eg python -m http.server 8000
  6. Visit http://localhost:8000/docs

Developing

Check todo.md.



© 2014 Amsul

Licensed under MIT