{"id":13558329,"url":"https://github.com/Doctave/doctave","last_synced_at":"2025-04-03T13:31:02.503Z","repository":{"id":42424634,"uuid":"294650775","full_name":"Doctave/doctave","owner":"Doctave","description":"A batteries-included developer documentation site generator","archived":false,"fork":false,"pushed_at":"2022-09-19T04:10:27.000Z","size":2524,"stargazers_count":556,"open_issues_count":22,"forks_count":33,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-11-04T09:37:11.913Z","etag":null,"topics":["cli","docs-as-code","doctave","documentation","documentation-generator","documentation-site","mermaid-diagrams","rust","static-site-generator"],"latest_commit_sha":null,"homepage":"https://cli.doctave.com","language":"Rust","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/Doctave.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-11T09:24:04.000Z","updated_at":"2024-10-14T20:17:13.000Z","dependencies_parsed_at":"2022-08-12T10:00:26.586Z","dependency_job_id":null,"html_url":"https://github.com/Doctave/doctave","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doctave%2Fdoctave","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doctave%2Fdoctave/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doctave%2Fdoctave/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doctave%2Fdoctave/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Doctave","download_url":"https://codeload.github.com/Doctave/doctave/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247009526,"owners_count":20868565,"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":["cli","docs-as-code","doctave","documentation","documentation-generator","documentation-site","mermaid-diagrams","rust","static-site-generator"],"created_at":"2024-08-01T12:04:52.994Z","updated_at":"2025-04-03T13:31:01.342Z","avatar_url":"https://github.com/Doctave.png","language":"Rust","readme":"[![CI Status](https://github.com/Doctave/doctave/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/Doctave/doctave/actions)\n[![Docs](./docs/_include/assets/doctave-badge.png)](https://cli.doctave.com/)\n\n\n![Doctave](./docs/_include/assets/doctave-logo-wide.png)\n\nDoctave is an opinionated documentation site generator that converts your Markdown files into\na beautiful documentation site with minimal effort.\n\nDoctave is not a generic static site generator - it is only meant for generating documentation sites\nfrom Markdown. This allows the tool to be much simpler than other solutions, with fewer\nconfiguration steps.\n\nThis open source tool is built and maintained by [Doctave.com](https://www.doctave.com).\n\n* [Docs](https://cli.doctave.com) (built with Doctave)\n* [Tutorial](https://cli.doctave.com/tutorial)\n\n## Features\n\nDoctave comes with a number of documentation-specific features out of the box. No plugins needed.\n\n- [Mermaid.js](https://mermaid-js.github.io/) diagrams\n- Offline full-text search\n- Local live-reloading server\n- Broken links checking\n- Typesetting for mathematical formulas\n- Responsive design\n- Dark mode\n- GitHub flavored markdown\n- Minimal configuration\n- Fast build times (Doctave is built with Rust)\n\n## Hosting\n\nDoctave-generated sites can be hosted on any static site hosting provider, such as [GitHub\nPages](https://pages.github.com/). You can also use [Doctave.com](https://www.doctave.com), which is\na specialized Doctave host, for free for public docs.\n\n## Screenshots\n\nYou can customize the color scheme and logo to match your own style. Below are two examples: one\nwith Doctave's own color scheme, and another customized color scheme.\n\nLight                                             | Dark                                                    |\n--------------------------------------------------|---------------------------------------------------------|\n![Exmple 1](./docs/_include/assets/example-1.png) | ![Example 2](./docs/_include/assets/example-1-dark.png) |\n![Exmple 2](./docs/_include/assets/example-2.png) | ![Example 2](./docs/_include/assets/example-2-dark.png) |\n\n## Installation\n\nThere are a few installation options for Doctave. If you would like another installation option,\nplease open an issue for it.\n\n### Precompiled binaries\n\nDoctave provides precompiled binaries for Mac, Linux, and Windows, which you can download from the\n[latest release page](https://github.com/Doctave/doctave/releases/latest).\n\n### Homebrew\n\nDoctave maintains its own [homebrew tap](https://github.com/Doctave/homebrew-doctave), and you can\ninstall Doctave via the following command:\n\n```\n$ brew install doctave/doctave/doctave\n```\n\nThis will take a few minutes as Doctave is compiled from scratch for your machine.\n\n### Cargo (Rust package manager)\n\nYou can also use the Rust package manager, Cargo, to install Doctave. Currently Doctave is not\nlisted on crates.io, but you can install it directly from GitHub:\n\n```\n$ cargo install --git https://github.com/Doctave/doctave --tag 0.4.2\n```\n\n## Getting started\n\nOnce you have Doctave installed, you can run the `init` command to create an initial docs site:\n\n```\n$ doctave init\n```\n\nThen, run the `serve` command to preview your site locally.\n\n```\n$ doctave serve\n\nDoctave | Serve\nStarting development server...\n\nServer running on http://0.0.0.0:4001/\n\n```\n","funding_links":[],"categories":["Rust","Documentation Generators","documentation","Uncategorized","General Tools"],"sub_categories":["Uncategorized","Site Builder"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDoctave%2Fdoctave","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDoctave%2Fdoctave","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDoctave%2Fdoctave/lists"}