{"id":29124260,"url":"https://github.com/niravcodes/documentinator","last_synced_at":"2026-03-14T05:32:19.431Z","repository":{"id":298579834,"uuid":"1000447036","full_name":"niravcodes/documentinator","owner":"niravcodes","description":"HTMLify your md notes","archived":false,"fork":false,"pushed_at":"2025-06-11T21:33:09.000Z","size":27,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-11T21:36:57.661Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://niravcodes.github.io/documentinator/","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/niravcodes.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-11T19:51:18.000Z","updated_at":"2025-06-11T21:34:49.000Z","dependencies_parsed_at":"2025-06-11T21:48:38.655Z","dependency_job_id":null,"html_url":"https://github.com/niravcodes/documentinator","commit_stats":null,"previous_names":["niravcodes/documentinator"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/niravcodes/documentinator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niravcodes%2Fdocumentinator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niravcodes%2Fdocumentinator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niravcodes%2Fdocumentinator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niravcodes%2Fdocumentinator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/niravcodes","download_url":"https://codeload.github.com/niravcodes/documentinator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niravcodes%2Fdocumentinator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262660010,"owners_count":23344440,"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":"2025-06-29T20:06:45.436Z","updated_at":"2026-03-14T05:32:19.355Z","avatar_url":"https://github.com/niravcodes.png","language":"JavaScript","readme":"# Documentinator\n\n_Behold, the Document-inator!_ A simple documentation builder.\n\nEvery project should have notes/docs folder in it's source code.\nHelps with formulating thoughts, keeping TODOs,\nrecording decisions and, increasingly these days, aiding LLMs. That notes/docs folder\nshould be committed to git just like code.\n\nMarkdown is great for noting down programmer-thought, and it plays well with version control.\nBut it is not too pretty to look at all the time.\n\nThis simple tool will serve your folder of markdown notes as HTML in the browser.\nIt supports nested folders and files. You can include local images and local markdown.\nUse mermaid diagrams too.\n\n![Documentinator Screenshot](./screenshot.png)\n\n## Usage\n\nDocumentinator provides two main commands:\n\n### Serve Documentation\n\n```bash\nnpx documentinator serve [docsDir]\n```\n\nThis command starts a local server to preview your documentation. By default, it looks for markdown files in the `./docs` directory.\n\n### Build Documentation\n\n```bash\nnpx documentinator build [docsDir]\n```\n\nThis command builds your documentation into static files. Like the serve command, it defaults to using the `./docs` directory if no path is specified.\n\nThe built HTML goes to ./dist folder.\n\n## Directory Structure\n\n\u003e [!NOTE]\n\u003e Template is optional. A sensible template has already been included.\n\n```\ndocs/\n  ├── your-markdown-files.md\n  └── template/\n      └── custom-template.html\n```\n\n## Custom Templates\n\nYou can create custom templates for your documentation by adding HTML files in the `docs/template` directory.\n\nThe simplest template might look like this:\n\n```html\n{{{sidebar}}} {{{content}}}\n```\n\nA more detailed default template can be found in the `template` folder.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fniravcodes%2Fdocumentinator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fniravcodes%2Fdocumentinator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fniravcodes%2Fdocumentinator/lists"}