Skip to content

zeropaper/grunt-gtfd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Stories in Ready

grunt-gtfd

A grunt task to generate the fine documentation.

Aim and goals

Docco is a great tool and at first I thought I could use it to document a project with several files (sometimes in sub-directories). But it didn't worked out the way I wanted and was difficult to theme (for me) as well. I thought about forking it. But it is written in CoffeeScript, I could not find the tests... and so on. So I started with a similar idea.

Features

  • Static: you can zip and share or serve the result as-is.
  • Simple: just like Docco
  • Directories: are not an issue

Usage

You probably should have a look at the Gruntfile.js.

The fine documentation

If you do not have grunt installed globally npm run-script docs otherwise grunt will generate the documentation in a docs directory.

Test

Without grunt globally installed npm test otherwise grunt mochacli.

Development

Without grunt globally installed

npm -g install grunt-cli
echo "sersiously?"
grunt dev-server

License

MIT

About

A grunt.js task to generate documentation.

Resources

License

Stars

Watchers

Forks

Packages

No packages published