https://github.com/twometer/cutedoc
🎀 Fast and clean static docs generator
https://github.com/twometer/cutedoc
docs-generator static-site theme
Last synced: over 1 year ago
JSON representation
🎀 Fast and clean static docs generator
- Host: GitHub
- URL: https://github.com/twometer/cutedoc
- Owner: Twometer
- License: mit
- Created: 2021-06-09T08:51:45.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-11-07T23:53:07.000Z (over 4 years ago)
- Last Synced: 2025-01-23T23:56:36.717Z (over 1 year ago)
- Topics: docs-generator, static-site, theme
- Language: Go
- Homepage: https://twometer.dev/p/cutedoc
- Size: 177 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🎀 Cutedoc
Cutedoc is a fast and clean static site generator for beautiful project documentation pages, written in Go.
## Features
- Write documentation using Markdown
- Easy to setup, with only a single `.ini` file
- Outputs static HTML that can be hosted anywhere
- Supports syntax highlighting and emojis
- Easily extensible with custom themes using [Go templates](https://pkg.go.dev/text/template)
- Built-in development server
## MkDocs theme
This project started as a theme for MkDocs, but I've since made it into its own static site generator. However, the MkDocs theme is still maintained under the [mkdocs branch](https://github.com/Twometer/cutedoc/tree/mkdocs). It's the same theme as the default theme for the new generator.
## License
MIT