docha
Generate documentation from your Mocha BDD specs
Last updated 2 years ago by teh_senaus .
BSD · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install docha 
SYNC missed versions from official npm registry.

docha

Generate documentation from your Mocha BDD tests

Install: npm install --save-dev docha

Usage

In your project directory, run:

docha

Note: This will overwrite any README.md file that was already there!

It assumes your Mocha tests are under test/.

Example

If we have the following in test/test.js:

describe('Something', function () {
	describe('some function', function () {
		it('does some work', function () {
			fn('data').should.equal('result')
		})
	})
})

The output README.md will be:

# Something
## some function
 some function does some work

```
fn('data').should.equal('result')
```

For a more fully-fledged example, see: https://github.com/tehsenaus/node-mkenv

Current Tags

  • 1.0.0                                ...           latest (2 years ago)

4 Versions

  • 1.0.0                                ...           2 years ago
  • 0.1.2                                ...           5 years ago
  • 0.1.1                                ...           7 years ago
  • 0.1.0                                ...           7 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 4
Dependencies (3)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |