docs

package

v1.0.5 Latest Latest Go to latest Published: Sep 6, 2026 License: AGPL-3.0 Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/abundo/factum2

Links

Open Source Insights

Documentation ¶

Overview ¶

Package docs embeds operator-facing Markdown from docs/user/ so the running factum2-web binary can serve the same pages as GitHub Pages. Install and design notes stay on disk for the public site / git; they are not embedded. A -tags release build overlays docs/generated/sbom.md onto the sbom page when that file was produced by `make sbom`.

Index ¶

Variables
type Page
- func Get(slug string) (Page, error)
- func List() ([]Page, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrInvalidSlug is returned when a requested slug is not a lowercase
	// hyphenated name (so path traversal never reaches ReadFile).
	ErrInvalidSlug = errors.New("invalid slug")
	// ErrNotFound is returned when no user doc matches a valid slug.
	ErrNotFound = errors.New("not found")
)

Functions ¶

This section is empty.

Types ¶

type Page ¶

type Page struct {
	Slug     string `json:"slug"`
	Title    string `json:"title"`
	Order    int    `json:"-"`
	Markdown string `json:"markdown,omitempty"`
}

Page is one operator doc. List omits Markdown; Get includes it.

func Get ¶

func Get(slug string) (Page, error)

Get returns one user doc by slug, including Markdown with front matter stripped.

func List ¶

func List() ([]Page, error)

List returns every docs/user/*.md page, ordered by front-matter `order` then title, without Markdown bodies.

Source Files ¶

View all Source files

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