https://github.com/tmpfs/markzero
Extensions to the marked library
https://github.com/tmpfs/markzero
Last synced: 4 months ago
JSON representation
Extensions to the marked library
- Host: GitHub
- URL: https://github.com/tmpfs/markzero
- Owner: tmpfs
- License: mit
- Created: 2014-02-27T09:39:31.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-08-23T02:34:54.000Z (almost 10 years ago)
- Last Synced: 2024-04-14T15:38:13.841Z (about 1 year ago)
- Language: JavaScript
- Size: 480 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Table of Contents
=================
* [markzero](#markzero)
* [Install](#install)
* [Features](#features)
* [Examples](#examples)
* [License](#license)
markzero
========
Extensions to the marked library.
This library extends the excellent [marked](https://github.com/chjj/marked) markdown parser to allow round tripping markdown to tokens and back to markdown. It also provides renderers to convert markdown to plain text and man pages.
Used by the [command](https://github.com/freeformsystems/cli-command) module and the [mdp](https://github.com/freeformsystems/mdp) program.
## Install
```
npm i markzero
```
## Features
* Convert markdown documents to tokens and back to markdown to programatically modify a document.
* Additional renderers for plain text and man pages.
* Builds link index for plain text documents.
* Supports nested ordered lists when converting back to markdown.
## Examples
Alternative versions of this document serve as examples:
* [README.txt](https://github.com/freeformsystems/markzero/blob/master/doc/alt/README.txt).
* [README.1](https://github.com/freeformsystems/markzero/blob/master/doc/alt/README.1).
* [README.html](https://github.com/freeformsystems/markzero/blob/master/doc/alt/README.html).
* [README.xhtml](https://github.com/freeformsystems/markzero/blob/master/doc/alt/README.xhtml).
## License
Everything is [MIT](http://en.wikipedia.org/wiki/MIT_License). Read the [license](https://github.com/freeformsystems/markzero/blob/master/LICENSE) if you feel inclined.
Generated by [mdp(1)](https://github.com/freeformsystems/mdp).
[marked]: https://github.com/chjj/marked
[mdp]: https://github.com/freeformsystems/mdp
[command]: https://github.com/freeformsystems/cli-command