0.6.3 • Published 1 year ago
hyper-markdown v0.6.3
Hyper-Markdown
This is a markdown superset, providing extra syntax.
This contains original markdown + GFM + specific Hyper-Markdown syntax.
Note: This package is built on top of a fork of Christopher Jeffrey's marked (MIT license).
Why another Markdown extension?
The objective of Hyper-Markdown is “zero HTML for content”.
Markdown, especially with the GFM extension, almost reached this goal, but there are still few common cases where HTML is still necessary.
Specific Hyper-Markdown syntax
- Block markup (at the begining of a line):
*
***
can be used as a third level of emphasis and generate amark
tag!![caption](url)
create a figure (block) tag containing an image or a media having url as source, it uses the text inside brackets as content for a figcaption tag:!![caption](url)
same, but make the figure float to the left (i.e. give it classes float and float-left)!!:[caption](url)
same, but make the figure float to the right (i.e give it classes float and float-right)|||
column break (close/open "column" custom tags)+++
(or+ + +
or++++++++
or anything following the horizontal rule syntax) are used as section break: it clears all columns and start over on a fresh one-column section (close/open "section" tags) automatic column span for header of table having less columns than the rest of the table headerless table support: start directly with the|---|---|
-like syntax caption table support: when using a header syntax with only one column but the|---|---|
-like separator has at least 2 columns, this line is considered as a caption instead of a header, a table header can still be added before the first separator multi-line table, using the|---|---|
-like syntax as row splitter, multi-line is supported for caption, header, and regular table body rows, separators are only necessary between regular table body rows- [ ]
or* [ ]
or+ [ ]
introduce a todo list item- [x]
or ` xor
+ xintroduce a todo list item done *
--` as a block markup is used to cite someone, usually inside a blockquote
Renderer object API
New methods / modified methods of marked module:
- .media( type , href , caption , float )
- .startSection( columnDepth )
- .endSection( columnDepth )
- .startColumn( columnDepth )
- .endColumn( columnDepth )
- .list( body , ordered , todoList )
- .listitem( text , checkbox )
- .cite( text )