https://github.com/padi2312/dorcs
Static site documentation generator
https://github.com/padi2312/dorcs
docs docs-generator documentation documentation-generator documentation-tool rust
Last synced: about 1 year ago
JSON representation
Static site documentation generator
- Host: GitHub
- URL: https://github.com/padi2312/dorcs
- Owner: Padi2312
- Created: 2024-03-17T18:26:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T01:42:11.000Z (about 2 years ago)
- Last Synced: 2024-04-13T02:28:51.254Z (about 2 years ago)
- Topics: docs, docs-generator, documentation, documentation-generator, documentation-tool, rust
- Language: Go
- Homepage: https://dorcs.allthing.eu
- Size: 428 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Dorcs
Static site generator in a single file 📄
This 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.
## 🖥️ Demo
See Dorcs in action [here](https://dorcs.allthing.eu). (same link as the documentation)
## 🚀 Features
- **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.
- **Sidebar navigation:** Dorcs automatically generates links for navigating between the different pages
- **Page Metadata:** Provide a title for a certain page. You can also provide the position of the page in the sidebar.
- **Hot Reload:** In watch mode, Dorcs watches the source directory for changes and regenerates the documentation whenever a change is detected.
- **Built-in Server:** Dorcs starts a local server to preview the generated documentation.
## 📄 Documentation
The documentatoin is available at **[dorcs.allthing.eu](https://dorcs.allthing.eu).**
The website is generated using Dorcs itself, you can find the source code for the documentation inside the `docs` directory.
## 🛠️ Setup
### 📥 Binary
Download pre-built binaries from the [releases section](https://github.com/Padi2312/dorcs/releases) for a quick start.
### 🛠️ Build from Source
To build from source, you need to have Go(lang) installed.
Clone the repository and run the following commands inside:
```sh
go generate ./build/gen.go
go build -o dorcs .
```
### 🧪 Experimental
In `develop` branch you can find the latest features and changes. Use with caution, there may be not working features or breaking changes.
You can find the nightly builds marked as pre-releases in the [releases section](https://github.com/Padi2312/dorcs/releases)
## 📚 Usage
1. Create a `docs` directory with an `index.md` file in it. This will be the landing page of your documentation.
2. Run Dorcs in the directory with the `docs` folder.
```sh
dorcs
```
This will generate the documentation in the `output` directory.