@doc-tools/transform

A simple transformer of text in YFM (Yandex Flavored Markdown) to HTML

Usage no npm install needed!

<script type="module">
  import docToolsTransform from 'https://cdn.skypack.dev/@doc-tools/transform';
</script>

README

english | русский

NPM version

A simple transformer of text in YFM (Yandex Flavored Markdown) to HTML.

Yandex Flavored Markdown

Yandex Flavored Markdown (YFM) is a Markdown dialect that is now used for Yandex.Cloud documentation, Yandex.Cloud website content, and in a variety of internal Yandex projects.

The syntax is based on the CommonMark Spec, extending it with additional features. It's designed for creating a full-fledged complex documentation project, such as the Yandex.Cloud documentation.

To build your documentation project in YFM, use the @doc-tools/docs package.

Learn more about YFM

Source files

Installation

git clone git@github.com:yandex-cloud/yfm-transform.git
cd yfm-transform
npm install

When you add changes to files from the SRC folder, before updating the package version, run

npm run dist

License

MIT