Builder
@doc-tools/docs is a package for building a documentation project with navigation, internal transitions, and full support for Yandex Flavored Markdown.
A built project is a set of static HTML files that can be viewed locally or on a host, in GitHub Pages, or in S3.
Installation
To install the package, run this command:
npm i @doc-tools/docs -g
Usage
The package provides the yfm
CLI command.
To start rendering, run the command specifying the required startup keys:
--input, -i
: The path to the project folder.--output, -o
: The path to the folder for output data (static HTMLs).
yfm -i ./input-folder -o ./ouput-folder