https://github.com/Alex-Rose/webmd
View markdown files in browser
https://github.com/Alex-Rose/webmd
Last synced: 6 months ago
JSON representation
View markdown files in browser
- Host: GitHub
- URL: https://github.com/Alex-Rose/webmd
- Owner: Alex-Rose
- License: mit
- Created: 2015-12-20T04:15:50.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2015-12-24T01:11:44.000Z (about 10 years ago)
- Last Synced: 2024-11-29T07:37:06.534Z (about 1 year ago)
- Language: HTML
- Size: 313 KB
- Stars: 15
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Web markdown viewer
## A static web markdown viewer
This simple static web page uses ajax to load a markdown file
and [markdown-js](https://github.com/evilstreak/markdown-js) to
render it on the client side.
Multiple themes from [bootswatch](https://github.com/thomaspark/bootswatch).
Navigation is handled client using javascript.
**Checkout a [live demo](http://step.polymtl.ca/~alexrose/webmd/)**
## How to use
### Write markdown content
You may refer to this [GitHub page](https://help.github.com/articles/markdown-basics/) for basic markdown syntax
### Deploy
* Put .md files in `content` directory
* Change `conf.js` values
* Change home button URL in `index.html`
### Use
Request pages using simple URL : example.com/my-file.md