typographic-markdown
Ready to use Textr plugin for markdown to make your typography better.
Transform your markdown using typographic-base
or other typographic-*
transformers, skipping code.
Install
npm install --save typographic-markdown
Usage
You can use it as a textr-compatible text transformer:
; ; // Hello, “world”…// … or with Ukrainian local (for example); // Hello, «world»…
Take a look how you to use it from CLI.
API
This plugin has similar API as remark-textr.
typographicMarkdown(text[, options, plugins])
Signatures:
typographicMarkdown(text[, options, plugins])
typographicMarkdown(text[, options|plugins])
text
Type: String
Default: ''
Text that will be transformed.
options
Type: Object
Default: { locale: 'en-us' }
It’s Textr’s options. Check out Textr usage section.
plugins
Type: Array
Default: ['typographic-base']
Array of Textr plugins. They are available on npm, labelled with textr keyword. Also you can easily create new one. Don’t be scared.
As default it uses typographic-base
bundle that already contains plugins you might want to use.
CLI
Easy to use typographic-markdown from your terminal using textr-cli:
# install textr-cli globaly, also don't forget about md-typographer $ npm install -g textr-cli typographic-markdown # … then run `textr` like so $ textr readme.md -t typographic-markdown -l uk -o fixed.md
Related
License
MIT © Denys Dovhan