docgen

command
v0.5.48 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 27, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

docgen generates a static web site from markdown and other files.

Usage:

go run dev/docgen/docgen.go

The generated web site is placed under website/public. The following types of files can be generated:

  1. Copy a file directly (see `staticFile` below).
  2. A markdown file can be converted to HTML and the result passed to a Go html/template.
  3. An HTML file can be pre-processed and the result passed to a Go html/template. The HTML file can contain embedded markdown formatted as <markdown>...</markdown> regions. Each such region is replaced with the region contents converted markdown to HTML.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL