ocean-markdown-it

Ocean markdown-it

Ocean markdown-it is a wrapper for markdown-it built to render Ocean-flavored Markdown (OFM).

Installation

npm install ocean-markdown-it or
yarn add ocean-markdown-it

Usage

Ocean markdown-it can be used as an inline replacement for markdown-it. The module exports an instance of markdown-it that has been created with all of the configuration and plugins necessary for properly rendering OFM.

const md = require('ocean-markdown-it')
html = md.render('# This is Ocean-flavored markdown {.title}')
console.log(html) // <h1 class="title">This is Ocean-flavored markdown</h1>

Supported divergences from Commonmark

• Code spans enclosed in single backticks are disabled.
• Indented blocks are rendered as block quotes instead of code blocks using markdown-it-indented-quotes.
• Block quotes are rendered as flat paragraphs with .blockquote class.
• Markdown lists are rendered as flat paragraphs with .li class using markdown-it-flat-lists.
• Footnotes and endnotes are implemented using markdown-it-footnote.
• HTML attributes (id, class, ¶ and data-*) are implemented using markdown-it-attrs.
• Explicit numbering of paragraphs with markdown-it-auto-parnum is supported with the ¶ attribute.
• Transliterated underlined characters are rendered using [markdown-it-macron-below].
• Page numbers are implemented using markdown-it-pagenumbers.
• Important typography is rendered using markdown-it-replacements.
• Underlined text is rendered in the <u> tag using markdown-it-underline.

Ocean-flavored Markdown (OFM)

Markdown is a widely-used convention for writing for the web, useful because it is easy and quick to write and creates a readable text document that converts well to HTML. The Markdown website has a good introduction for people who may find it unfamiliar. Ocean-flavored Markdown is an extension of this syntax designed to support literature. The specification is detailed at spec.md.