https://github.com/doowb/remarkable-defaults
Smart default options for the remarkable markdown parser.
https://github.com/doowb/remarkable-defaults
Last synced: over 1 year ago
JSON representation
Smart default options for the remarkable markdown parser.
- Host: GitHub
- URL: https://github.com/doowb/remarkable-defaults
- Owner: doowb
- License: mit
- Created: 2015-09-28T21:57:55.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-10-16T03:04:34.000Z (almost 11 years ago)
- Last Synced: 2025-02-25T23:16:03.511Z (over 1 year ago)
- Language: JavaScript
- Size: 137 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# remarkable-defaults [](http://badge.fury.io/js/remarkable-defaults) [](https://travis-ci.org/doowb/remarkable-defaults)
> Smart default options for the remarkable markdown parser.
Defaults originally pulled from [helper-markdown](https://github.com/helpers/helper-markdown/) and [helper-md](https://github.com/helpers/helper-md/)
Install with [npm](https://www.npmjs.com/)
```sh
$ npm i remarkable-defaults --save
```
## Usage
```js
var defaults = require('remarkable-defaults');
```
## API
### [.defaults](index.js#L47)
Get smart defaults for [remarkable](https://github.com/jonschlinkert/remarkable/) allowing overriding with your own options.
* `returns` **{Object}**: options object usable in [remarkable](https://github.com/jonschlinkert/remarkable/)
**Example**
```js
var md = new Remarkable(defaults({langPrefix: 'language-'}));
```
## Related projects
[remarkable](https://www.npmjs.com/package/remarkable): Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… [more](https://www.npmjs.com/package/remarkable) | [homepage](https://github.com/jonschlinkert/remarkable)
## Running tests
Install dev dependencies:
```sh
$ npm i -d && npm test
```
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/doowb/remarkable-defaults/issues/new).
## Author
**Brian Woodward**
+ [github/doowb](https://github.com/doowb)
+ [twitter/doowb](http://twitter.com/doowb)
## License
Copyright © 2015 Brian Woodward
Released under the MIT license.
***
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on September 28, 2015._