https://github.com/andrejewski/reem-markdown
Markdown for Reem
https://github.com/andrejewski/reem-markdown
Last synced: 3 months ago
JSON representation
Markdown for Reem
- Host: GitHub
- URL: https://github.com/andrejewski/reem-markdown
- Owner: andrejewski
- License: isc
- Created: 2014-06-24T00:45:56.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2014-07-31T12:29:37.000Z (over 11 years ago)
- Last Synced: 2025-04-29T11:42:11.402Z (9 months ago)
- Language: JavaScript
- Size: 152 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
reem-markdown
===
Markdown for Reem
## Installation
```bash
npm install reem-markdown # --save for projects
```
## Usage
```javascript
var markdown = require('reem-markdown');
reem.Post.use(markdown([options]));
```
## About
`reem-markdown` is a plugin for [Reem](https://github.com/andrejewski/reem) that will take file content (markdown) and transform it into HTML which will be set on the file's `content` property.
## Options
This plugin uses [`marked`](https://github.com/chjj/marked) for Markdown conversion and any options passed to this plugin are passed to the converter. If you would like things like Github favored Markdown and code highlighting, see Marked for how to accomplish those things.
## Contributing
If you have an issue or find a bug open an issue and I will see what we can do. If you can fix the bug yourself, by all means send a pull request for consideration.
Until `reem` and `reem-markdown` hit v1, I would like to keep backwards compatibility with the v0.0.1, treating it like v1. When the conditions are met for v1, we can cut away the cruft of v0.