wiki

package
v0.3.0 Latest Latest
Warning

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

 Go to latest Published: Dec 16, 2023 License: MIT Imports: 20 Imported by: 0

Documentation

Overview

Package wiki generates HTML from markdown for a given wiki.

Index

Constants

View Source 
const CHANGE_WAIT = 100 // milliseconds

Times to wait while waiting for changes to finish.

View Source 
const MAX_CHANGE_WAIT = 5000 // milliseconds
View Source 
const MAX_REGEN_INTERVAL = 10 // minutes

Max time before regenerating wiki while watching for changes.

Variables

This section is empty.

Functions

This section is empty.

Types

type Wiki 

type Wiki struct {
	// Directories
	SourceDir  string // Wiki source directory
	ContentDir string // Content directory within source directory
	DestDir    string // Dest directory where wiki will be generated
	// contains filtered or unexported fields
}

Wiki stores data about a single wiki.

func NewWiki 

func NewWiki(sourceDir, destDir string) (*Wiki, error)

NewWikiDirs constructs a new instance of WikiDirs.

func (*Wiki) Generate 

func (wiki *Wiki) Generate(regen, clean, watch bool, version string) error

Generate generates a wiki and then optionally watches for changes in the wiki to regenerate files on the fly.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.