Skip to content

gaurishhs/utdocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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
  • In-built Search functionality (powered by Fuse.js)

Installation

  • Head over to the releases page and download the latest binary for your platform.

Usage

Create a new project

git clone -b starter https://github.com/gaurishhs/utdocs.git

Start the development server

utdocs serve

Build the static site

utdocs generate