Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zestedesavoir/zmarkdown

Live demo: https://zestedesavoir.github.io/zmarkdown/
https://github.com/zestedesavoir/zmarkdown

markdown rehype remark

Last synced: 4 days ago
JSON representation

Live demo: https://zestedesavoir.github.io/zmarkdown/

Awesome Lists containing this project

README 

        
# ZMarkdown



  [![Build Status][build-badge]][build-status]

  [![Coverage Status][coverage-badge]][coverage-status]



This repository contains all the plugins for ZMarkdown, the Markdown engine powering [Zeste de Savoir][zds].



It is a collection of packages extending the [**remark** processor][processor] and its [**MDAST**][mdast] syntax tree, [**rehype**][rehype] (for HTML processing) and [**textr**][textr] (text transformation framework).

It also provides [**MDAST**][mdast] to LaTeX compilation via [**rebber**][rebber] (and its [plugins][rebber-plugins]).



Currently, all the plugins provided only work for remark versions **lesser than** 13.0.0 (i.e. previous to [**micromark**][micromark]). While we intend to switch to the new system, no due date has been planned, and it requires a significant amount of work, so please be patient, or, even better, help us making the switch!



## Install



### Prerequisites



* node >= 18

* npm >= 9



### Installation



1. `git clone [email protected]:zestedesavoir/zmarkdown.git`

1. `npm install`



This project uses [Jest][jest] for testing. It is recommended to use the locally installed version using `npx`, and run Jest in watch mode when developing `npx jest --watch --notify` (`--notify` sends desktop notifications when tests run).



### Useful commands



* `npm run test` : tests all packages.

* `npm run clean` : clears local dependencies, reinstalls the project and runs all tests.

* `npm run lint` : runs [eslint][eslint] to check the syntax of the full codebase.

* `npm run build` : builds packages using [babel][babel].

* `npm run build -- --scope=` : same as above, but builds only ``.



## Packages



* [**mdast-util-split-by-heading**][mdast-util-split-by-heading]



  A MDAST tool to split a markdown tree into list of subtrees representing the chapters. It relies on heading depth.



* [**rebber**][rebber]



  transformation of MDAST into `latex` code. This code must be included inside a custom latex to be compiled.

  Have a look at `https://github.com/zestedesavoir/latex-template/blob/master/zmdocument.cls` to get a working example.



* [**remark-abbr**][remark-abbr]



  This plugin parses `*[ABBR]: abbr definition` and then replace all ABBR instance in text with a new MDAST node so that `rehype` can parse it into `abbr` html tag.



* [**rehype-footnotes-title**][rehype-footnotes-title]



  This plugin adds a `title` attribute to the footnote links, mainly for accessibility purpose.



* [**rehype-html-blocks**][rehype-html-blocks]



  This plugin wraps (multi-line) raw HTML in `p`.



* [**remark-align**][remark-align]



  This plugin parses custom Markdown syntax to center- or right-align elements.



* [**remark-captions**][remark-captions]



  Allow to add caption to such element as image, table or blockquote.



* [**remark-comments**][remark-comments]



  This plugin parses custom Markdown syntax for Markdown source comments.



* [**remark-custom-blocks**][remark-custom-blocks]



  This plugin parses custom Markdown syntax to create new custom blocks.



* [**remark-emoticons**][remark-emoticons]



  This plugins replaces ASCII emoticons with associated image. Compatible with [rehype][rehype]



* [**remark-escape-escaped**][remark-escape-escaped]



  This plugin escapes HTML entities from Markdown input.



* [**remark-grid-tables**][remark-grid-tables]



  This plugin parses custom Markdown syntax to describe tables.



* [**remark-heading-shift**][remark-heading-shift]



  Allows to shift heading to custimize the way you will integrate the generated tree inside your application.



* [**remark-heading-trailing-spaces**][remark-heading-trailing-spaces]



  This plugin removes trailing spaces from Markdown headers.



* [**remark-iframes**][remark-iframes]



  Allows to add `iframe` inclusion through `!(url)` code.



* [**remark-kbd**][remark-kbd]



  This plugin parses custom Markdown syntax to handle keyboard keys.



* [**remark-numbered-footnotes**][remark-numbered-footnotes]



  This plugin changes how [mdast][mdast] footnotes are displayed by using sequential numbers as footnote references instead of user-specified strings.



* [**remark-sub-super**][remark-sub-super]



  This plugin parses custom Markdown syntax to handle subscript and superscript.



* [**typographic-colon**][typographic-colon]



  Micro module to fix a common typographic issue that is hard to fix with most keyboard layouts.



* [**typographic-permille**][typographic-permille]



  Micro module to replace `%o` with `‰` and optionally replace the preceding space.



* [**zmarkdown**][zmarkdown]



  Fully integrated package to be used in [zeste de savoir website](https://zestedesavoir.com)



## License



[MIT][license] © [Zeste de Savoir][zds]



[build-badge]: https://travis-ci.com/zestedesavoir/zmarkdown.svg?branch=master

[build-status]: https://travis-ci.com/zestedesavoir/zmarkdown

[coverage-badge]: https://coveralls.io/repos/github/zestedesavoir/zmarkdown/badge.svg?branch=master



[coverage-status]: https://coveralls.io/github/zestedesavoir/zmarkdown?branch=master

[license]: https://github.com/zestedesavoir/zmarkdown/blob/master/LICENSE-MIT



[processor]: https://github.com/remarkjs/remark/blob/master/packages/remark

[mdast]: https://github.com/wooorm/mdast

[micromark]: https://github.com/micromark/micromark

[pyzmd]: https://github.com/zestedesavoir/Python-ZMarkdown

[zds]: https://zestedesavoir.com

[rehype]: https://github.com/rehypejs/rehype

[textr]: https://github.com/A/textr

[jest]: https://facebook.github.io/jest/

[eslint]: https://github.com/eslint/eslint

[babel]: https://github.com/babel/babel



[mdast-util-split-by-heading]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/mdast-util-split-by-heading#mdast-util-split-by-heading--

[rebber]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/rebber#rebber--

[rebber-plugins]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/rebber-plugins#rebber-plugins--

[remark-abbr]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-abbr#remark-abbr--

[rehype-footnotes-title]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/rehype-footnotes-title#rehype-footnotes-title--

[rehype-html-blocks]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/rehype-html-blocks#rehype-html-blocks--

[remark-align]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-align#remark-align--

[remark-captions]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-captions#remark-captions--

[remark-comments]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-comments#remark-comments--

[remark-custom-blocks]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-custom-blocks#remark-custom-blocks--

[remark-emoticons]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-emoticons#remark-emoticons--

[remark-escape-escaped]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-escape-escaped#remark-escape-escaped--

[remark-grid-tables]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-grid-tables#remark-grid-tables--

[remark-heading-shift]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-heading-shift#remark-heading-shift--

[remark-heading-trailing-spaces]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-heading-trailing-spaces#remark-heading-trailing-spaces--

[remark-iframes]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-iframes#remark-iframes--

[remark-kbd]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-kbd#remark-kbd--

[remark-numbered-footnotes]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-numbered-footnotes#remark-numbered-footnotes--

[remark-sub-super]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-sub-super#remark-sub-super--

[typographic-colon]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/typographic-colon#typographic-colon--

[typographic-permille]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/typographic-permille#typographic-permille--

[zmarkdown]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/zmarkdown#zmarkdown--