Diplodoc CLI (yfm-docs)
yfm-docs
Diplodoc platform CLI for building Yandex Flavored Markdown documentation with navigation and multiple languages
Install
npm i @diplodoc/cli -gRequires Node.js 22+
This is third-party code. Review the repository files before installing.
What it does
The @diplodoc/cli package builds a full documentation project with navigation and Yandex Flavored Markdown support. yfm init scaffolds a project with toc.yaml, index.md and settings, including multi-language layouts. yfm content processes a single Markdown file into md or an HTML fragment, and the --raw flag prints clean content without banners, which suits agents and pipelines.
Who it is for. Technical writers and developers maintaining docs-as-code documentation.
Good fit when
- You start a new YFM documentation portal
- You need Russian and English docs in one project
- An agent needs to render one page with includes and variables without building the whole project
- You want CI to fail on warnings with --strict
Not a fit when
- Your docs already use another generator and migration is not planned
- Your environment cannot run Node.js 22 or newer
Example request
Create a Diplodoc documentation project with ru and en languages using the full template, then render index.md to HTMLLimitations
Requires Node.js 22+. yfm content handles a single file and for HTML emits only a fragment without toc or header. The VCS connector needs a GitHub token in .env or .yfm.
How to disable. Remove the global package with npm uninstall -g @diplodoc/cli.
Security check
- Works with local documentation files
- The VCS connector uses a GitHub token if configured
README in short
yfm-docs builds documentation projects with navigation and YFM support. The README covers npm installation, yfm init with an interactive wizard and flags, and yfm content for processing a single file. It lists options, generated file layouts and VCS connector setup. The project is MIT-licensed and has a Russian README.
FAQ
How do I get only the content without service output?
Add --raw to yfm content: stdout will contain only the result, without markers or banners.
What is the difference between the minimal and full templates?
full also creates presets.yaml, pc.yaml and an extended .yfm with pdf, search, vcs and authors settings.
Related
Anthropic skills
Skills
Anthropic's official skill examples: docx, pdf, pptx and xlsx documents, design, MCP builder and the Agent Skills spec
Claude Code skills for the academic pipeline: research, paper drafting, peer review and citation checks
Turns a technical book or a folder of documents into a structured skill with chapters, a glossary and a cheatsheet
A skill for editable draw.io diagrams from text, code, Terraform, Kubernetes, SQL and OpenAPI, with export and self-checks