{"id":18292170,"url":"https://github.com/padi2312/dorcs","last_synced_at":"2025-04-09T07:54:30.491Z","repository":{"id":228237508,"uuid":"773465518","full_name":"Padi2312/dorcs","owner":"Padi2312","description":"Static site documentation generator","archived":false,"fork":false,"pushed_at":"2024-04-13T01:42:11.000Z","size":438,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-13T02:28:51.254Z","etag":null,"topics":["docs","docs-generator","documentation","documentation-generator","documentation-tool","rust"],"latest_commit_sha":null,"homepage":"https://dorcs.allthing.eu","language":"Go","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/Padi2312.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":"2024-03-17T18:26:59.000Z","updated_at":"2024-06-19T09:06:41.729Z","dependencies_parsed_at":"2024-06-19T09:24:01.296Z","dependency_job_id":null,"html_url":"https://github.com/Padi2312/dorcs","commit_stats":null,"previous_names":["padi2312/dorcs"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Padi2312%2Fdorcs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Padi2312%2Fdorcs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Padi2312%2Fdorcs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Padi2312%2Fdorcs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Padi2312","download_url":"https://codeload.github.com/Padi2312/dorcs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247999852,"owners_count":21031044,"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":["docs","docs-generator","documentation","documentation-generator","documentation-tool","rust"],"created_at":"2024-11-05T14:17:02.680Z","updated_at":"2025-04-09T07:54:30.466Z","avatar_url":"https://github.com/Padi2312.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./docs/dorcs_logo.png\" alt=\"Dorcs Logo\" width=\"200\"\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eDorcs\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003eStatic site generator in a single file 📄\u003c/strong\u003e\n\u003c/p\u003e\n\nThis project is a documentation generator written in Rust. It reads markdown files from a specified directory, converts them to HTML, and saves the generated HTML files to another specified directory.\n\n## 🖥️ Demo\n\nSee Dorcs in action [here](https://dorcs.allthing.eu). (same link as the documentation)\n\n## 🚀 Features\n\n- **Markdown to HTML Conversion:** The project reads markdown files and converts them to HTML. This is done in the documents loop in the generate_docs function of the Generator struct.\n\n- **Sidebar navigation:** Dorcs automatically generates links for navigating between the different pages\n\n- **Page Metadata:** Provide a title for a certain page. You can also provide the position of the page in the sidebar.\n\n- **Hot Reload:** In watch mode, Dorcs watches the source directory for changes and regenerates the documentation whenever a change is detected.\n\n- **Built-in Server:** Dorcs starts a local server to preview the generated documentation.\n\n## 📄 Documentation\n\nThe documentatoin is available at **[dorcs.allthing.eu](https://dorcs.allthing.eu).**\n\nThe website is generated using Dorcs itself, you can find the source code for the documentation inside the `docs` directory.\n\n\n## 🛠️ Setup\n\n### 📥 Binary\n\nDownload pre-built binaries from the [releases section](https://github.com/Padi2312/dorcs/releases) for a quick start.\n\n### 🛠️ Build from Source\n\nTo build from source, you need to have Go(lang) installed.\n\nClone the repository and run the following commands inside:\n\n```sh\ngo generate ./build/gen.go\n\ngo build -o dorcs .\n```\n\n\n### 🧪 Experimental\n\nIn  `develop` branch you can find the latest features and changes. Use with caution, there may be not working features or breaking changes.\n\nYou can find the nightly builds marked as pre-releases in the [releases section](https://github.com/Padi2312/dorcs/releases)\n\n## 📚 Usage\n\n1. Create a `docs` directory with an `index.md` file in it. This will be the landing page of your documentation.\n2. Run Dorcs in the directory with the `docs` folder.\n\n```sh\ndorcs\n```\n\nThis will generate the documentation in the `output` directory.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpadi2312%2Fdorcs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpadi2312%2Fdorcs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpadi2312%2Fdorcs/lists"}