https://github.com/bloqhead/mdoc

Just a simple way to generate documentation for a project. Good for handing off to a third party developer or a client.
https://github.com/bloqhead/mdoc

Last synced: about 2 months ago
JSON representation

Just a simple way to generate documentation for a project. Good for handing off to a third party developer or a client.

• Host: GitHub
• URL: https://github.com/bloqhead/mdoc
• Owner: bloqhead
• Created: 2015-01-29T22:07:59.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-11-11T16:08:33.000Z (about 7 years ago)
• Last Synced: 2023-03-25T12:44:13.738Z (almost 2 years ago)
• Language: CSS
• Size: 91.8 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: ReadMe.md

Awesome Lists containing this project

README

        
# Markdown => HTML Doc Generator

## Wtf is this shit

Just a simple way to generate documentation for a project. Good for

handing off to a third party developer or a client. It will output

HTML files from your markdown files and then automatically generate

a table of contents and a jump menu for going to sections of your

documents.

## Getting started

1. Clone the repo (duh)

2. Run `$ npm install`

3. Run `$ grunt watch`

4. Start creating markdown files and placing them in the `md` directory

5. Go to the project root folder in your favorite web browser

6. ?????

7. PROFIT!

### Credits

* [GruntJS](http://gruntjs.com)

* [md2html](https://www.npmjs.com/package/md2html)