docs

Documentation

Overview

Package docs handles Readeck's documentation files and HTTP routes.

Index

• Variables
• func SetupRoutes(s *server.Server)
• type File
  • func (f *File) UpdateEtag(h hash.Hash)
• type Manifest
• type Section

Variables

var Files http.FileSystem

Files contains all the generated help files as an http.FS instance.

Functions

func SetupRoutes

func SetupRoutes(s *server.Server)

SetupRoutes mounts the routes for the auth domain.

Types

type File

type File struct {
	Route      string         `json:"route"`
	Aliases    []string       `json:"aliases"`
	File       string         `json:"file"`
	Etag       string         `json:"etag"`
	IsDocument bool           `json:"is_document"`
	Title      string         `json:"title"`
	Meta       map[string]any `json:"meta"`
}

File is a documentation file.

func (*File) UpdateEtag

func (f *File) UpdateEtag(h hash.Hash)

UpdateEtag implements the server.Etagger interface.

type Manifest

type Manifest struct {
	Files    map[string]*File    `json:"files"`
	Sections map[string]*Section `json:"sections"`
}

Manifest is the documentation files manifest.

type Section

type Section struct {
	Files map[string]*File `json:"files"`
	TOC   [][2]string      `json:"toc"`
}

Section is a documentation language section.