{"id":22452623,"url":"https://github.com/totaltechgeek/doczen","last_synced_at":"2026-05-09T15:16:41.865Z","repository":{"id":57699763,"uuid":"503391886","full_name":"TotalTechGeek/doczen","owner":"TotalTechGeek","description":"Bundle \u0026 validate documentation within your codebase","archived":false,"fork":false,"pushed_at":"2022-06-20T17:28:07.000Z","size":62,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-22T15:02:17.855Z","etag":null,"topics":["confluence","markdown"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TotalTechGeek.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-06-14T14:21:33.000Z","updated_at":"2022-06-14T18:23:58.000Z","dependencies_parsed_at":"2022-09-26T21:10:36.336Z","dependency_job_id":null,"html_url":"https://github.com/TotalTechGeek/doczen","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TotalTechGeek%2Fdoczen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TotalTechGeek%2Fdoczen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TotalTechGeek%2Fdoczen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TotalTechGeek%2Fdoczen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TotalTechGeek","download_url":"https://codeload.github.com/TotalTechGeek/doczen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245850155,"owners_count":20682632,"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":["confluence","markdown"],"created_at":"2024-12-06T06:11:55.305Z","updated_at":"2026-05-09T15:16:39.787Z","avatar_url":"https://github.com/TotalTechGeek.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Doczen\n\n\u003cp align=\"center\"\u003e\n\u003cimg width=500 alt=\"An image of a dachshund with the title Doczen underneath it\" src=\"./images/doczen%20logo-01.svg\" /\u003e\u003cbr/\u003e \u003cp align=\"center\" style=\"font-size: 18px;\"\u003eA tool to supercharge your documentation. \u003c/p\u003e\n\nDoczen is a tool that'll fetch documentation from your projects for bundling, validation, and exporting to other systems, like Confluence.\n\n### What this project is / is not\n\nDoczen is best used as a tool to enhance your documentation \u0026 configuration pipelines, making it easier to aggregate \u0026 filter those items for export or validation.\n\nHowever, because there are many excellent solutions out there (Docusaurus, GitBook, Hugo, and many more), Doczen will not attempt to build websites natively.\n\nInstead, we encourage you to use Doczen to feed those tools, and in the near future guides will be added to show an example pipeline that does so.\n\n## CLI Usage\n\n```txt\n$ doczen -h confluence -h current -h copy\nVersion: 0.0.5\nMain: A tool designed to super-charge your code-base's documentation.\n-i, --input \u003cglob\u003e       Glob of files to parse. (You may use multiple -i flags)\n-p, --prefix \u003cprefix\u003e    Prefix to add to all titles.\n-x, --export \u003cmodule\u003e    A module used by doczen, executed left to right.\n-h, --help \u003cmodule\u003e      Gets help for the specified module.\n-t \u003cfile\u003e                Uses an exported \"transform\" function to preprocess documentation before it is used.\n--exclude \u003cglob\u003e         Glob of files to ignore. (You may use multiple --exclude flags)\n\n\nConfluence: Exports a collection of markdown files to Confluence.\n-s, --space \u003cspace\u003e     The space key to export to\n-u, --url \u003curl\u003e         The url of the confluence instance\n\n\nCurrent: Validates that the documentation is up to date by checking the files that it references.\n\nNo command line options.\n\nIn the header of your documentation, you may specify a \"files\" property, which is an array of globs. Ex.\nfiles: [\"*.tsx\"]\n\n\nCopy: Exports the documentation / configuration files to a specified folder. \nUsually to use with a build stage in a pipeline.\n--to \u003cfolder\u003e     The folder to export to.\n--extension \u003cext\u003e The extension to use for the files. (default: md)\n--plain           Do not export the header information.\n\nRemember that you can use a \"-t\" flag to preprocess the files before they are exported,\nthis is useful if you need to inject additional metadata.\n```\n\n### Examples\n\n```txt\n---\ntitle: Our Cool Component API\nfiles: [\"*.tsx\"] \n---\n\n# Our Cool Component API\n\n...\n```\n\n```bash\n# Validate that the documentation is newer than the code it describes (uses the \"files\" annotation)\ndoczen -i \"src/**/*.md\" -x current\n```\n\n``` bash\n# Export the documentation to Confluence\ndoczen -i \"src/**/*.md\" -x confluence -u doczen -s DOC\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftotaltechgeek%2Fdoczen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftotaltechgeek%2Fdoczen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftotaltechgeek%2Fdoczen/lists"}