https://github.com/doodlewind/imdoc
markdown documentation generator
https://github.com/doodlewind/imdoc
Last synced: 8 months ago
JSON representation
markdown documentation generator
- Host: GitHub
- URL: https://github.com/doodlewind/imdoc
- Owner: doodlewind
- Created: 2016-09-14T14:15:22.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-12-23T06:56:02.000Z (over 9 years ago)
- Last Synced: 2025-01-26T02:17:00.170Z (over 1 year ago)
- Language: CSS
- Size: 6.84 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# imdoc
markdown documentation generator
## Install
``` text
npm install -g imdoc
```
## Usage
### Basic
Generate HTML from markdown file(s):
``` text
imdoc file1.md file2.md ...
```
`imdoc` generates HTML in the same path of corresponding markdown file path.
### Code Example
`imdoc` supports generating bootstrap-flavored HTML/CSS/JS front end code examples. Run
``` text
imdoc example.md
```
in `imdoc` source folder to see how it works.
### Watcher
File watcher on single markdown file is also supported:
``` text
imdoc watch file.md
```
## Changelog
* `1.0.1`:
* Fix codec issue
* `1.1.0`:
* Add watcher
* Add code example generator
* Update `Github2.css` theme
* `1.0.1`:
* Add basic markdown convert support
* `1.0.0`:
* Init repository
## License
MIT