https://github.com/tuwukee/lemon_docs
markdown based documentation
https://github.com/tuwukee/lemon_docs
Last synced: about 1 year ago
JSON representation
markdown based documentation
- Host: GitHub
- URL: https://github.com/tuwukee/lemon_docs
- Owner: tuwukee
- License: mit
- Created: 2017-01-21T19:54:53.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-08T07:41:31.000Z (over 8 years ago)
- Last Synced: 2025-03-24T00:02:21.457Z (about 1 year ago)
- Language: Ruby
- Size: 11.7 KB
- Stars: 2
- Watchers: 4
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Lemon Docs
TODO: Add description
## Installation
### As gem
`gem install lemon_docs`
### From source
```
git clone git@github.com:tuwukee/lemon_docs.git
cd lemon_docs
rake
```
## Usage
Convert API Blueprint files to JSON.
```
require 'lemon_docs'
LemonDocs.parse('# API doc', strict: true, show_output: true)
```
LemonDocs#parse also accepts named params 'strict' and 'show_output', enabled by default. If strict mode is disabled, warnings are ignored.
Or via rake task. Generated files will be placed under doc/lemon_pages.
```
rake lemon_docs:generate_json[path/to/folder]
```
## Contributing
Fork & Pull Request
## License
MIT License.