{"id":17037121,"url":"https://github.com/perryvw/mermaid-markdown-docs","last_synced_at":"2026-01-19T22:00:45.515Z","repository":{"id":66024967,"uuid":"597865921","full_name":"Perryvw/mermaid-markdown-docs","owner":"Perryvw","description":"A documentation framework allowing you to easily make a documentation website from markdown files, with mermaid diagrams and search built-in!","archived":false,"fork":false,"pushed_at":"2023-09-19T17:58:12.000Z","size":493,"stargazers_count":2,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-09T10:48:16.145Z","etag":null,"topics":["documentation","esbuild","lunr","markdown","mermaid","search"],"latest_commit_sha":null,"homepage":"https://perryvw.github.io/mermaid-markdown-docs/","language":"TypeScript","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/Perryvw.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}},"created_at":"2023-02-05T21:23:41.000Z","updated_at":"2024-08-20T20:09:38.000Z","dependencies_parsed_at":"2024-12-19T04:28:54.065Z","dependency_job_id":"45a990c7-73c4-4577-a310-b1a5736303b7","html_url":"https://github.com/Perryvw/mermaid-markdown-docs","commit_stats":{"total_commits":47,"total_committers":1,"mean_commits":47.0,"dds":0.0,"last_synced_commit":"c23e66dbca154df2abbbb16c7afe8d7517d0db20"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/Perryvw/mermaid-markdown-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Perryvw%2Fmermaid-markdown-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Perryvw%2Fmermaid-markdown-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Perryvw%2Fmermaid-markdown-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Perryvw%2Fmermaid-markdown-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Perryvw","download_url":"https://codeload.github.com/Perryvw/mermaid-markdown-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Perryvw%2Fmermaid-markdown-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28587024,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-19T20:45:59.482Z","status":"ssl_error","status_checked_at":"2026-01-19T20:45:41.500Z","response_time":67,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["documentation","esbuild","lunr","markdown","mermaid","search"],"created_at":"2024-10-14T08:52:55.315Z","updated_at":"2026-01-19T22:00:45.496Z","avatar_url":"https://github.com/Perryvw.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mermaid-Markdown-Docs\n\nMermaid-Markdown-Docs is a framework to easily create documentation websites from markdown files, with minimal setup.\n\nLive demo: [Mermaid-Markdown-Docs documentation](https://perryvw.github.io/mermaid-markdown-docs/)\n\n## Built-in features:\n\n-   Create a documentation website entirely from markdown files\n-   Built-in support for [Mermaid diagrams](https://mermaid.js.org/)\n-   Built-in search functionality using [Lunr.js](https://lunrjs.com/)\n-   Development server with automatic reloading when changes are detected\n-   Fast build speeds thanks to running on esbuild\n-   Independent output bundle, it is just html and js, it can run anywhere!\n\n# Installation\n\nThe package `mermaid-markdown-docs` can be installed from npm using the following command:\n\n```\nnpm i -D mermaid-markdown-docs\n```\n\n# Documentation\n\nFind our documentation - generated using mermaid-markdown-docs from this repository - here: [Mermaid-Markdown-Docs documentation](https://perryvw.github.io/mermaid-markdown-docs/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperryvw%2Fmermaid-markdown-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fperryvw%2Fmermaid-markdown-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperryvw%2Fmermaid-markdown-docs/lists"}