Collection of examples and notes for my Markdownlint presentation
-
SlideShare: Markdownlint, my presentation referencing this GitHub repository
-
CommonMark specification of open Markdown-inspired variation
-
Markdownlint: (
mdl
) the first and original implementation in Ruby -
Markdownlint: implementation in Node inspired and based on the Ruby implementation
-
Markdownlint Command Line Interface: (
markdownlint
) GUI for the above Markdownlint Node library implementation -
Sublime Text Markdown editing plugin, based on the Ruby implementation (
mdl
) -
Visual Studio Code Markdownlint plugin, based on the Node implementation
{
"default": true
}
Basic configuration in JSON for markdownlint
, enabling all rules
language: node_js
node_js:
- '6'
install:
- npm install -g markdownlint-cli
script:
- markdownlint *.md ; markdownlint */*.md
Example lifted from: jonasbn: TIL (Today I Learned)
Example of staged builds:
language: node_js
node_js:
- '6'
before_install:
- sudo apt-get install -y libxml2-utils
install:
- npm install -g markdownlint-cli
jobs:
include:
- stage: "Documentation test"
name: "Markdown test"
script: markdownlint README.md
- stage: "Product test"
name: "XML/XSD test"
script: xmllint --schema epp.xsd xml/*.xml
Example lifted from: DK Hostmaster: epp-xml-files
See the fine result at Travis CI