https://github.com/gaurishhs/utdocs
Minimalistic Documentation generator in Golang
https://github.com/gaurishhs/utdocs
documentation-generator documentation-tool golang static-site-generator
Last synced: 2 months ago
JSON representation
Minimalistic Documentation generator in Golang
- Host: GitHub
- URL: https://github.com/gaurishhs/utdocs
- Owner: gaurishhs
- License: mit
- Created: 2022-12-03T09:37:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-10T07:43:09.000Z (over 2 years ago)
- Last Synced: 2025-02-02T03:44:29.453Z (4 months ago)
- Topics: documentation-generator, documentation-tool, golang, static-site-generator
- Language: Go
- Homepage: https://utdocs.gaurishsethia.me
- Size: 19.3 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
UTDocs is a powerful clean documentation generator written in Golang.
## Features
- Write documentation using Markdown
- Outputs static HTML that can be hosted anywhere (Github Pages, S3, etc)
- Supports syntax highlighting and emojis
- Easily extensible with custom themes using [Go templates](https://pkg.go.dev/text/template)
- In-built Search functionality (powered by [Fuse.js](https://fusejs.io/))
## Installation
- Head over to the [releases](https://github.com/gaurishhs/utdocs/releases) page and download the latest binary for your platform.
## Usage
### Create a new project
```bash
git clone -b starter https://github.com/gaurishhs/utdocs.git
```
### Start the development server
```bash
utdocs serve
```
### Build the static site
```bash
utdocs generate
```