The package provides the
yfm CLI command.
Default output format of the builder is html
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
You can choose to build project in YFM.
To do this, when executing the
yfm command, specify the startup key
Building in YFM allows you to use:
- Inserts and section visibility conditions in tables of contents files.
- Content visibility conditions on document pages.
- Variable substitutions if the
apply-presetsparameter is specified.
Use this type of build to support multiple document versions for different users. For example, if there are sections with internal information in the documentation, you can keep two repositories: private and public, and synchronize private with public using conditions.