Robotskirt plugin for Wintersmith. It will render Markdown content using Robotskirt. Code highlighting is done via highlight.js.
This repo is meant to be used as a plugin for Wintersmith-generated websites. To use this plugin, simply setup a wintersmith website and follow the setup instructions below.
Setting up the plugin is very simple:
npm install wintersmith-robotskirt
Alternatively, you can define the plugin as a dependency in your package.json
file and run:
npm install
In your config.json
file, you must define the location of the plugin:
"plugins": [
"./node_modules/wintersmith-robotskirt/"
]
You may configure how robotskirt parses the Markdown content using Robotskirt
extensions. Simply define the extensions you wish to use in config.json
as
follows:
"robotskirt": {
"extensions": [
"ext_fenced_code",
"ext_no_intra_emphasis",
"ext_tables",
"ext_strikethrough",
"ext_superscript"
]
}
You may also configure how the HTML renderer outputs your html files. Identify
the flags you need in config.json
:
"robotskirt": {
"htmlFlags": [
"html_use_xhtml",
"html_hard_wrap"
]
}
- ext_autolink
- ext_fenced_code
- ext_lax_spacing
- ext_no_intra_emphasis
- ext_space_headers
- ext_strikethrough
- ext_superscript
- ext_tables
- html_skip_html
- html_skip_style
- html_skip_images
- html_skip_links
- html_expand_tabs
- html_safelink
- html_toc
- html_hard_wrap
- html_use_xhtml
- html_escape
If you wish to enable Smartypants, add the following to config.json
:
"robotskirt": {
"smart": true
}
After doing the initial setup and configuration, your wintersmith builds will automatically use Robotskirt to render html pages.
"wintersmith-robotskirt" is Copyright (c) 2014 by Byron Sanchez, licensed under the GNU GPL v2.0.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2 of the License.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
"wintersmith-robotskirt" includes works under other copyright notices and distributed according to the terms of the GNU General Public License or a compatible license, including:
Portions of wintersmith-showdown Copyright (c) 2014 Luke Hagan (lukehagan.com), licensed under the MIT License