Documentation build parameters

Launch flag

Description

--input, -i

Path to the project directory. By default, the current directory.

--output, -o

Path to the output directory (required parameter).

--vars-preset <name>

Name of the variable preset used.

--vars, -v

Values of variables.

--strict, -s

Run in strict mode.

YFM warnings are treated as errors. Disabled by default.

--quiet, -q

Run in quiet mode.

Do not output logs to stdout. Disabled by default.

--jobs, -j

Run in multithreaded mode.
If a specific number of threads is not specified, it is calculated automatically based on system parameters

--jobs 4, -j4, -j

--config, -c

Path to the configuration file.

--extensions, -e

Connecting external extensions at startup.

The path passing differs for exec flags and the .yfm configuration. For exec flags, paths are specified relative to the directory where the command is executed. For configuration, paths are passed from the configuration directory.

Example:

yfm -e @diplodoc/openapi-extension
yfm -e ./local-extension

--watch, -w

Launch watch build mode.

--lang, --langs

Configure supported languages.

--output-format, -f

Format of the final build files. Available options: html, md. By default, html.

--allow-html

Allow using HTML in markdown files.

--sanitize-html

Enable HTML sanitization.

--allow-custom-resources

Allow loading custom resources on statically generated pages.

--static-content

Build the article's HTML content as part of the layout. By default, it is in a JS object and is inserted into the page during rendering in the browser.

--theme <color>

Enable the themer. More details - here.

--ignore

Do not process paths matching the pattern.

Example:

build -i ./input -o ./output --ignore *.bad.md

or

build -i ./ -o ./build --ignore ./build

--ignore-stage

Do not process table of contents files with the specified level. By default, ["skip"].

--template

Select the operating mode for templates. By default, text mode is enabled, which ignores code blocks. Use all or code to process code blocks.

Possible values:

• text;

• all;

• code.

--template-vars

Toggle the processing mode for variables in double curly braces. Enabled by default.

--template-conditions

Toggle the processing mode for conditional operators. Enabled by default.

--vcs

Enable fetching data from the VCS. This parameter only controls enabling/disabling.
Each VCS connector has its own configuration. It should be described in the connector's documentation.

--mtimes

Enable displaying the article modification date. The data is taken from the VCS.

--authors

Enable displaying the article author. The data is taken from the VCS.

--contributors

Enable displaying contributors in the article. The data is taken from the VCS.

--lint

Attach the linter file. Enabled by default. To disable, use --no-lint.

--llms

Enable generation of llms.txt and llms-full.txt files for the project.

--llms-full-max-size <value>

Limit on the size of the generated llms-full.txt file for a single article; if exceeded, filling the file with data stops with code YFM022 (the build does not fail with an error). Accepts numbers and strings like: 1024, 512K, 2M.

--changelogs

Beta feature. Toggle processing of the experimental changelog syntax.

--single-page

Build the project as a single HTML file. See more in the Single-page build section.

--output-format

Generation format. HTML by default, but you can configure building in YFM.

--apply-presets

Substitute variable values from presets when building in YFM.

--remove-hidden-toc-items

Remove hidden pages from the build result. Disabled by default.

--skip-html-extension

Remove the .html extension and the index.html file name from internal links to articles.

--add-map-file

Add creation of file.json with all paths to the documentation. Disabled by default.

--build-stats

Write a yfm-build-stats.json file next to the output with build metrics (duration, page and asset counters, artifact size). See more in Build statistics. Enabled by default for builds with --output-format=md, disabled for others. To disable, use --no-build-stats.

--build-content

Write a yfm-build-content.json file next to the output with content hashes of each file and page → assets dependencies. Used by external tools (search reindexing, change notifications) to compute the set of pages changed between two builds. See more in Build content map. Enabled by default for builds with --output-format=md, disabled for others. To disable, use --no-build-content.

--disable-csp

Disable adding the Content-Security-Policy meta tag to generated HTML pages. Enabled by default.

--max-asset-size <value>

Limit on the asset size in the project; if exceeded, the build fails with the error YFM013. Accepts numbers and strings like: 1024, 512K, 2M.

If you specify 0, asset size checking will not be performed.

By default, 64M.

--max-html-size <value>

Limit on the size of the HTML content of a single article; if exceeded, the build fails with the error YFM012. Accepts numbers and strings like: 1024, 512K, 2M.

Works only when building with --output-format html.

By default, 42M, maximum value 96M.

--max-inline-svg-size <value>

Maximum allowed size of an SVG image at which it is automatically inlined into the article content. If the size is exceeded, the SVG image is inserted via the <img> tag. Accepts numbers and strings like: 1024, 512K, 2M.

If you specify 0, SVG images will not be inlined during the build.

By default, 2M, maximum value 16M.

--max-openapi-include-size <value>

Maximum allowed size of a file built from an OpenAPI specification. If the file size is exceeded, the JSON schema is cut out of it. Accepts numbers and strings like: 1024, 512K, 2M.

If you specify 0, there is no limit.

--multiline-term-definitions

Enables support for multiple line breaks in tooltips.

--version

Current version.