{"id":17999456,"url":"https://github.com/ozum/devkeeper-docs","last_synced_at":"2025-06-13T15:04:06.771Z","repository":{"id":42272454,"uuid":"262578753","full_name":"ozum/devkeeper-docs","owner":"ozum","description":"README and VuePress generator.","archived":false,"fork":false,"pushed_at":"2023-01-06T05:24:33.000Z","size":1701,"stargazers_count":0,"open_issues_count":10,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-23T01:15:10.625Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/ozum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-09T13:37:48.000Z","updated_at":"2020-05-13T13:20:37.000Z","dependencies_parsed_at":"2023-02-05T10:16:53.937Z","dependency_job_id":null,"html_url":"https://github.com/ozum/devkeeper-docs","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ozum%2Fdevkeeper-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ozum%2Fdevkeeper-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ozum%2Fdevkeeper-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ozum%2Fdevkeeper-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ozum","download_url":"https://codeload.github.com/ozum/devkeeper-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247135147,"owners_count":20889421,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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-10-29T22:13:06.362Z","updated_at":"2025-04-04T07:14:53.358Z","avatar_url":"https://github.com/ozum.png","language":"TypeScript","readme":"# devkeeper-docs\n\n\n\nOpinionated CLI to generate README and build VuePress. It may be used in CI/CD such as GitHub actions.\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n\n- [Synopsis](#synopsis)\n- [Details](#details)\n  - [README](#readme)\n  - [VuePress](#vuepress)\n- [CLI](#cli)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n\n# Synopsis\n\n`$ npx devkeeper-docs readme`\n\nBuild opinionated VuePress\n\n`$ npx devkeeper-docs vuepress`\n\n# Details\n\n## README\n\n`$ npx devkeeper-docs readme`\n\n* Creates `README.md` from `README.njk` nunjucks template using `readmeasy`.\n* If there is no `README.njk` template, creates one.\n* Adds header with `{% include \u0026quot;module-header\u0026quot; %}` (name, description table of contents, badges). See [`readmeasy`](https://www.npmjs.com/package/readmeasy) for details.\n* Adds API documentation with `{% include \u0026quot;api.md\u0026quot; %}` using [`TypeDoc`](https://typedoc.org/).\n* Adds [`oclif`](https://oclif.io/) CLI tool README parts if `oclif` is used in project.\n\n## VuePress\n\n`$ npx devkeeper-docs vuepress`\n\nBuilds VuePress. We suggest you to use [`vuepress-bar`](https://www.npmjs.com/package/vuepress-bar) to easily create VuePress sidabar and top menu.\n\n# CLI\n\n\u003c!-- usage --\u003e\n```sh-session\n$ npm install -g devkeeper-docs\n$ devkeeper-docs COMMAND\nrunning command...\n$ devkeeper-docs (-v|--version|version)\ndevkeeper-docs/0.1.15 darwin-x64 node-v14.1.0\n$ devkeeper-docs --help [COMMAND]\nUSAGE\n  $ devkeeper-docs COMMAND\n...\n```\n\u003c!-- usagestop --\u003e\n\n\u003c!-- commands --\u003e\n* [`devkeeper-docs add-scripts`](#devkeeper-docs-add-scripts)\n* [`devkeeper-docs autocomplete [SHELL]`](#devkeeper-docs-autocomplete-shell)\n* [`devkeeper-docs help [COMMAND]`](#devkeeper-docs-help-command)\n* [`devkeeper-docs readme`](#devkeeper-docs-readme)\n* [`devkeeper-docs typedoc-html`](#devkeeper-docs-typedoc-html)\n* [`devkeeper-docs typedoc-md`](#devkeeper-docs-typedoc-md)\n* [`devkeeper-docs typedoc-single-md`](#devkeeper-docs-typedoc-single-md)\n* [`devkeeper-docs vuepress`](#devkeeper-docs-vuepress)\n* [`devkeeper-docs vuepress-dev`](#devkeeper-docs-vuepress-dev)\n\n## `devkeeper-docs add-scripts`\n\nCreates Readme from TypeScript and README template using readmeasy and Typeoc.\n\n```\nUSAGE\n  $ devkeeper-docs add-scripts\n```\n\n_See code: [lib/commands/add-scripts.js](https://github.com/ozum/devkeeper-docs/blob/v0.1.15/lib/commands/add-scripts.js)_\n\n## `devkeeper-docs autocomplete [SHELL]`\n\ndisplay autocomplete installation instructions\n\n```\nUSAGE\n  $ devkeeper-docs autocomplete [SHELL]\n\nARGUMENTS\n  SHELL  shell type\n\nOPTIONS\n  -r, --refresh-cache  Refresh cache (ignores displaying instructions)\n\nEXAMPLES\n  $ devkeeper-docs autocomplete\n  $ devkeeper-docs autocomplete bash\n  $ devkeeper-docs autocomplete zsh\n  $ devkeeper-docs autocomplete --refresh-cache\n```\n\n_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.2.0/src/commands/autocomplete/index.ts)_\n\n## `devkeeper-docs help [COMMAND]`\n\ndisplay help for devkeeper-docs\n\n```\nUSAGE\n  $ devkeeper-docs help [COMMAND]\n\nARGUMENTS\n  COMMAND  command to show help for\n\nOPTIONS\n  --all  see all commands in CLI\n```\n\n_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.0.0/src/commands/help.ts)_\n\n## `devkeeper-docs readme`\n\nCreates Readme from TypeScript and README template using readmeasy and Typeoc.\n\n```\nUSAGE\n  $ devkeeper-docs readme\n```\n\n_See code: [lib/commands/readme.js](https://github.com/ozum/devkeeper-docs/blob/v0.1.15/lib/commands/readme.js)_\n\n## `devkeeper-docs typedoc-html`\n\nUsing `typedoc`, creates series of HTML files from TypeScript files\n\n```\nUSAGE\n  $ devkeeper-docs typedoc-html\n```\n\n_See code: [lib/commands/typedoc-html.js](https://github.com/ozum/devkeeper-docs/blob/v0.1.15/lib/commands/typedoc-html.js)_\n\n## `devkeeper-docs typedoc-md`\n\nUsing `typedoc`, creates a series of MarkDown files from TypeScript files.\n\n```\nUSAGE\n  $ devkeeper-docs typedoc-md\n```\n\n_See code: [lib/commands/typedoc-md.js](https://github.com/ozum/devkeeper-docs/blob/v0.1.15/lib/commands/typedoc-md.js)_\n\n## `devkeeper-docs typedoc-single-md`\n\nUsing `typedoc`, creates a MarkDown files from TypeScript files\n\n```\nUSAGE\n  $ devkeeper-docs typedoc-single-md\n```\n\n_See code: [lib/commands/typedoc-single-md.js](https://github.com/ozum/devkeeper-docs/blob/v0.1.15/lib/commands/typedoc-single-md.js)_\n\n## `devkeeper-docs vuepress`\n\nBuilds VuePress Site\n\n```\nUSAGE\n  $ devkeeper-docs vuepress\n```\n\n_See code: [lib/commands/vuepress.js](https://github.com/ozum/devkeeper-docs/blob/v0.1.15/lib/commands/vuepress.js)_\n\n## `devkeeper-docs vuepress-dev`\n\nStarts VuePress development server.\n\n```\nUSAGE\n  $ devkeeper-docs vuepress-dev\n```\n\n_See code: [lib/commands/vuepress-dev.js](https://github.com/ozum/devkeeper-docs/blob/v0.1.15/lib/commands/vuepress-dev.js)_\n\u003c!-- commandsstop --\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fozum%2Fdevkeeper-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fozum%2Fdevkeeper-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fozum%2Fdevkeeper-docs/lists"}