{"id":51142380,"url":"https://github.com/shazeus/docsmith-cli","last_synced_at":"2026-06-26T00:01:58.811Z","repository":{"id":364256857,"uuid":"1242061042","full_name":"shazeus/docsmith-cli","owner":"shazeus","description":"Documentation generator and converter CLI","archived":false,"fork":false,"pushed_at":"2026-06-12T08:43:06.000Z","size":13,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-12T10:21:41.849Z","etag":null,"topics":["cli","converter","documentation","flask","markdown","python","static-site"],"latest_commit_sha":null,"homepage":null,"language":"Python","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/shazeus.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-18T05:11:24.000Z","updated_at":"2026-06-12T08:43:05.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/shazeus/docsmith-cli","commit_stats":null,"previous_names":["shazeus/docsmith-cli"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/shazeus/docsmith-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shazeus%2Fdocsmith-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shazeus%2Fdocsmith-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shazeus%2Fdocsmith-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shazeus%2Fdocsmith-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shazeus","download_url":"https://codeload.github.com/shazeus/docsmith-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shazeus%2Fdocsmith-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34796761,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-25T02:00:05.521Z","response_time":101,"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":["cli","converter","documentation","flask","markdown","python","static-site"],"created_at":"2026-06-26T00:01:57.397Z","updated_at":"2026-06-26T00:01:58.762Z","avatar_url":"https://github.com/shazeus.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ch1 align=\"center\"\u003eDocsmith\u003c/h1\u003e\n  \u003cp align=\"center\"\u003eDocumentation generator, converter, inspector, and preview server for developer docs.\u003c/p\u003e\n  \u003cp align=\"center\"\u003e\n    \u003ca href=\"https://pypi.org/project/docsmith-cli/\"\u003e\u003cimg alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/docsmith-cli.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://pypi.org/project/docsmith-cli/\"\u003e\u003cimg alt=\"Python\" src=\"https://img.shields.io/pypi/pyversions/docsmith-cli.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"LICENSE\"\u003e\u003cimg alt=\"License\" src=\"https://img.shields.io/badge/license-MIT-green.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/shazeus/docsmith-cli/stargazers\"\u003e\u003cimg alt=\"Stars\" src=\"https://img.shields.io/github/stars/shazeus/docsmith-cli.svg?style=social\"\u003e\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n---\n\nDocsmith is a terminal-first documentation toolkit for projects that need clean Markdown-to-site publishing without a heavy static-site framework. It can scaffold documentation, scan and validate existing docs, render a static HTML site, convert files between Markdown, HTML, text, JSON, and PDF, search content, extract outlines, and serve a local preview through Flask.\n\n- **Static site builder** - Render Markdown or HTML docs into a responsive documentation site with navigation and copied assets.\n- **Format conversion** - Convert documentation files to HTML, Markdown, text, JSON metadata, or a lightweight text PDF.\n- **Schema-style inspection** - Summarize files, line counts, word counts, headings, links, and checksums in Rich tables or JSON.\n- **Validation checks** - Detect broken local links, duplicate heading anchors, and Markdown files without headings.\n- **Fast preview server** - Serve generated docs locally with a minimal Flask app.\n- **Search and outline tools** - Locate content across a docs tree and inspect heading structure from the terminal.\n\n## Installation\n\n```bash\npip install docsmith-cli\n```\n\n## Usage\n\nCreate a starter documentation folder:\n\n```bash\ndocsmith init docs --title \"My Project Docs\"\n```\n\nInspect and validate the documentation tree:\n\n```bash\ndocsmith scan docs\ndocsmith validate docs\n```\n\nBuild a static site and serve it locally:\n\n```bash\ndocsmith build docs --out site\ndocsmith serve docs --port 8080\n```\n\nConvert a Markdown file:\n\n```bash\ndocsmith convert docs/index.md --to html --out build/index.html\ndocsmith convert docs/index.md --to pdf\n```\n\n## Commands\n\n| Command | Description |\n| --- | --- |\n| `docsmith init \u003cpath\u003e` | Create a starter documentation scaffold. |\n| `docsmith scan \u003cpath\u003e` | Inspect documentation files and summarize size, headings, links, and checksums. |\n| `docsmith build \u003cpath\u003e` | Build a static HTML documentation site. |\n| `docsmith convert \u003cfile\u003e --to \u003cformat\u003e` | Convert docs to HTML, Markdown, text, JSON, or PDF. |\n| `docsmith validate \u003cpath\u003e` | Check broken local links, duplicate heading anchors, and missing headings. |\n| `docsmith outline \u003cfile\u003e` | Display a heading outline for one documentation file. |\n| `docsmith search \u003cpath\u003e \u003cquery\u003e` | Search documentation content. |\n| `docsmith serve \u003cpath\u003e` | Start a local Flask preview server. |\n\n## Configuration\n\nDocsmith works without configuration. The CLI accepts explicit paths and output flags for each command. A typical project layout is:\n\n```text\ndocs/\n  index.md\n  guide.md\n  reference.md\nsite/\n  index.html\n  assets/docsmith.css\n```\n\nUse `--json-output` with `scan` or `outline` when integrating Docsmith into CI or project automation.\n\n## License\n\nMIT License. See [LICENSE](LICENSE).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshazeus%2Fdocsmith-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshazeus%2Fdocsmith-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshazeus%2Fdocsmith-cli/lists"}