Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ad-si/mardow
The Ultimate Markdown Viewer
https://github.com/ad-si/mardow
markdown markdown-viewer server
Last synced: 8 days ago
JSON representation
The Ultimate Markdown Viewer
- Host: GitHub
- URL: https://github.com/ad-si/mardow
- Owner: ad-si
- Created: 2013-09-25T10:28:39.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2019-04-30T22:07:58.000Z (over 5 years ago)
- Last Synced: 2024-10-06T15:33:48.663Z (about 1 month ago)
- Topics: markdown, markdown-viewer, server
- Language: JavaScript
- Size: 623 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mardow
The ultimate markdown viewer.
## Installation
```sh
npm install --global mardow
```
## Get Started
```sh
mardow serve README.md
```
For more information run:
```sh
mardow --help
```
## Features
- Uses [Marked] to convert Markdown to HTML
- The acute accent is used to mark [AsciiMath] parts
which will get rendered by [MathJax].
So e.g. ´f(x) = 1/x^2´ will get rendered with the proper math layout.
(**Attention**: Make sure to escape ambiguous characters
like "\_" from the markdown parser with a backslash "\\")
[AsciiMath]: http://asciimath.org
[Marked]: https://github.com/markedjs/marked
[MathJax]: https://www.mathjax.org
## Features
- Highlighting even works correctly when there are several sections
with the same name