@doc-tools/transform
TypeScript icon, indicating that this package has built-in type declarations

3.11.0 • Public • Published

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

Dependencies (15)

Dev Dependencies (30)

Package Sidebar

Install

npm i @doc-tools/transform

Weekly Downloads

754

Version

3.11.0

License

MIT

Unpacked Size

848 kB

Total Files

342

Last publish

Collaborators

  • martyanov-av
  • moki
  • yc-ui-robot
  • yfm-team
  • monsterzz
  • buran
  • yndx-birman111