https://github.com/thlorenz/gendo

Generates docs via documentationjs, updates README checks that in and then generates github pages with nicely rendered docs.
https://github.com/thlorenz/gendo

Last synced: 15 days ago
JSON representation

Generates docs via documentationjs, updates README checks that in and then generates github pages with nicely rendered docs.

• Host: GitHub
• URL: https://github.com/thlorenz/gendo
• Owner: thlorenz
• License: mit
• Created: 2017-01-25T16:27:04.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-02-28T17:11:13.000Z (over 5 years ago)
• Last Synced: 2024-10-18T00:29:30.801Z (20 days ago)
• Language: Shell
• Homepage:
• Size: 6.45 MB
• Stars: 8
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gendo

Generates docs via [documentationjs](http://documentation.js.org/), updates README checks that in and then generates

github pages with nicely rendered docs.

![assets/gendo.gif](assets/gendo.gif)

```

# let documentationjs find the files to document

gendo

# specify the files to generate docs for

gendo file1.js lib/file2.js

```

## Requirements

- a `README.md` with an API section, i.e. `## API`

- a `gh-pages` branch, if not found it is generated for you

## Installation

    npm install gendo

## Docs generated with gendo

### ah-collector 

- [readme](https://github.com/thlorenz/ah-collector)

- [gh-pages](https://thlorenz.github.io/ah-collector)

## License

MIT