Help

Snider Labs

Documentation Go MkDocs

A Go module for bundling documentation directly into your application. Extracted from the Core framework, it lets you embed help files using Go's embed.FS, so your docs travel with your binary. No separate web server needed - just call Show() and your users get contextual help.

View on GitHub → Report Issue

Features

Embedded Documentation

Bundle documentation directly with your application using Go's embed.FS

Flexible Sources

Configure from embedded filesystems or custom directory paths

Topic Navigation

Navigate to specific sections using anchor links with URL normalisation

Development Server

Built-in support for mkdocs-material during development

Installation

pip install -r requirements.txt
mkdocs serve

Usage

Show() opens documentation to the main page. ShowAt() navigates to specific sections using anchor notation (e.g., "ui/how/settings#resetPassword").

Quick Links

Repository Issues Pull Requests Releases

More from Snider Labs

View all projects →

Fancy helping out?

Spotted a bug? Got an idea? We'd love to hear from you.

Read the contributing guide →