https://github.com/venkatperi/grunt-atomdoc-md
https://github.com/venkatperi/grunt-atomdoc-md
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/venkatperi/grunt-atomdoc-md
- Owner: venkatperi
- Created: 2016-05-25T23:01:56.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-05-26T00:19:16.000Z (about 9 years ago)
- Last Synced: 2025-03-22T04:17:38.962Z (3 months ago)
- Language: CoffeeScript
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# grunt-atomdoc-md
Grunt plugin for `atomdoc-md` -- creates markdown from your project's atomdoc.
# Installation
Install with npm.
```shell
npm install --save-dev grunt-atomdoc-md
```
# Usage
## Defaults
```coffeescript
#in your Gruntfile
tasks :
atomdoc_md :
default: # defaults below
module: '.' # which module?
doc: 'doc' # doc/output dir
name: 'api.md' # generated file name
level: 'info' # logging level
```
## Generate README.md
```coffeescript
atomdoc_md :
readme: # defaults below
module: '.' # which module?
doc: '.' # doc/output dir
name: 'README.md' # generated file name
```
`atomdoc-md` looks for two files to auto import into the generated file:
* `intro.md` is added to be front of the output
* `appendix.md` is added after all of the generated content
Both files must be in the `doc` directory.