{"id":13937883,"url":"https://github.com/diplodoc-platform/cli","last_synced_at":"2026-04-06T08:06:22.964Z","repository":{"id":37561502,"uuid":"259930743","full_name":"diplodoc-platform/cli","owner":"diplodoc-platform","description":"Lets make documentation on YFM","archived":false,"fork":false,"pushed_at":"2026-04-02T15:29:50.000Z","size":13571,"stargazers_count":123,"open_issues_count":93,"forks_count":47,"subscribers_count":28,"default_branch":"master","last_synced_at":"2026-04-03T04:58:35.863Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/diplodoc-platform.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2020-04-29T13:20:06.000Z","updated_at":"2026-04-01T15:15:33.000Z","dependencies_parsed_at":"2022-07-12T16:23:37.952Z","dependency_job_id":"5d6fdf11-5a01-478f-8a84-a2294804bb7b","html_url":"https://github.com/diplodoc-platform/cli","commit_stats":null,"previous_names":["diplodoc-platform/cli","yandex-cloud/yfm-docs"],"tags_count":541,"template":false,"template_full_name":null,"purl":"pkg:github/diplodoc-platform/cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/diplodoc-platform%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/diplodoc-platform%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/diplodoc-platform%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/diplodoc-platform%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/diplodoc-platform","download_url":"https://codeload.github.com/diplodoc-platform/cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/diplodoc-platform%2Fcli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31464194,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T21:22:52.476Z","status":"online","status_checked_at":"2026-04-06T02:00:07.287Z","response_time":112,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-07T23:03:59.704Z","updated_at":"2026-04-06T08:06:22.942Z","avatar_url":"https://github.com/diplodoc-platform.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"**english** | [русский](https://github.com/diplodoc-platform/cli/blob/master/README.ru.md)\n\n---\n\n[![NPM version](https://img.shields.io/npm/v/@diplodoc/cli.svg?style=flat)](https://www.npmjs.org/package/@diplodoc/cli)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_cli\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_cli)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_cli\u0026metric=coverage)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_cli)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_cli\u0026metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_cli)\n[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_cli\u0026metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_cli)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_cli\u0026metric=security_rating)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_cli)\n\n# yfm-docs\n\nYfm-docs lets you build a full-fledged documentation project: with navigation, internal transitions, and full\n[Yandex Flavored Markdown (YFM)](https://diplodoc.com/docs/en/index-yfm) support.\n\n![Example of displaying a documentation page](.github/assets/overview.jpg)\n\n## Documentation\n\n[ydocs.tech](https://diplodoc.com/docs/en/tools/docs)\n\n## Requirements\n\nNode 22+\n\n## Usage\n\n```bash\nnpm i @diplodoc/cli -g\n```\n\n```bash\nnpm run start -- -i ./input-folder -o ./ouput-folder -v \"{\\\"name\\\":\\\"Alice\\\"}\"\n```\n\n## Source files\n\n### Preparation\n\nYou need to add `.env` file into repo root with data below:\n\n```bash\nGITHUB_OWNER=\nGITHUB_REPO= # docs\nGITHUB_TOKEN= # personal access token\nGITHUB_BASE_URL= # for ex: https://api.github.com\nVCS_CONNECTOR_TYPE= # github\n```\n\nor you can update .yfm file into docs repo\n\n```bash\nconnector:\n    type:\n    github:\n        endpoint:\n        token:\n        owner:\n        repo:\n```\n\n### Build from source\n\n```bash\ncd cli\nnpm ci \u0026\u0026 npm run build\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiplodoc-platform%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdiplodoc-platform%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiplodoc-platform%2Fcli/lists"}