Documentation ¶
Overview ¶
Package docs handles Readeck's documentation files and HTTP routes.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var Files http.FileSystem
Files contains all the generated help files as an http.FS instance.
Functions ¶
func SetupRoutes ¶
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) GetSumStrings ¶
GetSumStrings implements the Etager interface.
Click to show internal directories.
Click to hide internal directories.