{"id":15386658,"url":"https://github.com/zerodevx/zero-md-docs","last_synced_at":"2025-04-15T17:32:58.547Z","repository":{"id":57405632,"uuid":"251240971","full_name":"zerodevx/zero-md-docs","owner":"zerodevx","description":"Instantly publish markdown from Github docs folder","archived":false,"fork":false,"pushed_at":"2024-09-23T14:41:11.000Z","size":569,"stargazers_count":10,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-29T00:23:30.171Z","etag":null,"topics":["api-documentation-tool","markdown-to-html","zero-md"],"latest_commit_sha":null,"homepage":"","language":"Svelte","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zerodevx.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}},"created_at":"2020-03-30T08:09:13.000Z","updated_at":"2025-01-08T05:14:38.000Z","dependencies_parsed_at":"2024-10-18T18:54:27.640Z","dependency_job_id":"606a5f77-aad1-4f91-a2ce-ffec48732f9f","html_url":"https://github.com/zerodevx/zero-md-docs","commit_stats":{"total_commits":53,"total_committers":2,"mean_commits":26.5,"dds":"0.018867924528301883","last_synced_commit":"b01175cc8cc53efa84d7c083045a0c4ae5bdca55"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zerodevx%2Fzero-md-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zerodevx%2Fzero-md-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zerodevx%2Fzero-md-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zerodevx%2Fzero-md-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zerodevx","download_url":"https://codeload.github.com/zerodevx/zero-md-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249118946,"owners_count":21215645,"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":["api-documentation-tool","markdown-to-html","zero-md"],"created_at":"2024-10-01T14:50:05.130Z","updated_at":"2025-04-15T17:32:58.267Z","avatar_url":"https://github.com/zerodevx.png","language":"Svelte","readme":"# zero-md-docs\n\n\u003e Instantly publish markdown from Github docs folder\n\nElegantly leverage on your Github docs folder as a public-facing documentation website. Super easy\nto use, barely an inconvenience. Inspired by [`docsify`](https://docsify.js.org).\n\n## Usage\n\nStructure your `docs/` folder like so:\n\n```text\n.\n└── docs/\n    ├── readme.md               # TOC (navigation menu)\n    ├── index.html              # Copy from template\n    ├── home.md                 # ...Site pages\n    ├── getting-started.md\n    └── config.md\n    ...\n    └── any-other-page.md\n```\n\n### Copy `index.html`\n\nCopy and paste the following code into `docs/index.html`:\n\n\u003c!-- prettier-ignore --\u003e\n```html\n\u003c!-- index.html --\u003e\n\u003c!doctype html\u003e\n\u003chtml lang=\"en\"\u003e\n  \u003chead\u003e\n    \u003cmeta charset=\"utf-8\" /\u003e\n    \u003cmeta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" /\u003e\n    \u003c!-- Import modules and stylesheet --\u003e\n    \u003cscript type=\"module\" src=\"https://cdn.jsdelivr.net/npm/zero-md@3?register\"\u003e\u003c/script\u003e\n    \u003cscript type=\"module\" src=\"https://cdn.jsdelivr.net/npm/zero-md-docs@1\"\u003e\u003c/script\u003e\n    \u003clink rel=\"stylesheet\" href=\"https://cdn.jsdelivr.net/npm/zero-md-docs@1/dist/default.min.css\" /\u003e\n  \u003c/head\u003e\n  \u003cbody\u003e\n    \u003c!-- Declare `app` entry point --\u003e\n    \u003cdiv id=\"app\"\u003e\u003c/div\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n\n### Add `readme.md`\n\nCreate `docs/readme.md` containing a table of contents (or site links). This acts as the site\nnavigation menu.\n\n```text\n\u003c!-- readme.md --\u003e\n- [Home](home.md)\n- [Getting Started](getting-started.md)\n- [Configuration](config.md)\n...\n- [External Link](https://example.com/)\n```\n\n\u003e [!NOTE]  \n\u003e The first link is always the home page.\n\n### Publish with Github Pages\n\nFrom your Github repo page, go to `Settings -\u003e Pages`, set `Source` to `Deploy from a branch`, and\nset `Branch` to `/docs`...\n\n```\n░██████╗░█████╗░██╗░░░██╗███████╗██╗\n██╔════╝██╔══██╗██║░░░██║██╔════╝██║\n╚█████╗░███████║╚██╗░██╔╝█████╗░░██║\n░╚═══██╗██╔══██║░╚████╔╝░██╔══╝░░╚═╝\n██████╔╝██║░░██║░░╚██╔╝░░███████╗██╗\n╚═════╝░╚═╝░░╚═╝░░░╚═╝░░░╚══════╝╚═╝\n```\n\n...and voila - your site is now available at `https://\u003cuser\u003e.github.io/\u003crepo\u003e/`.\n\n## License\n\nISC\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzerodevx%2Fzero-md-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzerodevx%2Fzero-md-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzerodevx%2Fzero-md-docs/lists"}