Help improve FileBrowser documentation using our Hugo-based structure.

Documentation Structure

Static Site Generator: Hugo Theme: Custom FileBrowser Docs Theme Deployment: Auto-generated during releases Format: Markdown with YAML front matter

Repository Structure

TEXT 
1
2
3
4
5

docs/
├── content/docs/           # All documentation pages
├── layouts/               # Theme overrides
├── assets/               # Custom CSS/JS
└── hugo.toml             # Site configuration

Creating New Pages

1. Add Page to Section

Create new markdown file in appropriate folder:

BASH 
1

docs/content/docs/Configuration/new-page.md

2. Add Front Matter

YAML 
1
2
3
4
5

---
title: "Page Title"
description: "Brief description (40-60 chars)"
icon: "material_symbol_name"
---

3. Write Content

No H1 headers - Title comes from front matter. Use H2 (##) for sections.

MARKDOWN 
1
2
3
4
5
6
7
8
9

Brief introduction paragraph.

## Section Heading

Content here...

## Next Steps

- Related topic

4. Test Locally

BASH 
1
2

cd docs
hugo server

View at: http://localhost:1313/docs/

Front Matter Fields

FieldRequiredDescription
titleYesPage title (appears in navigation and header)
descriptionYesBrief description (shows in next/prev cards)
iconNoMaterial Symbol icon name

Icons

Uses Material Symbols. Search for icon, copy name, add to front matter: icon: "settings"

Content Guidelines

  • Clear and concise: Get to the point quickly
  • Actionable: Provide steps users can follow
  • Examples: Include code examples and configurations
  • Accurate: Only document actual features (no speculation)

Code Blocks

Use language-specific syntax highlighting:

MARKDOWN 
1
2
3
4
5
6
7
8

```yaml
server:
  port: 80
```

```bash
./filebrowser -c config.yaml
```

Internal links: Use absolute paths from /docs/

MARKDOWN 
1

Configuration

External links: Use full URLs

MARKDOWN 
1

[GitHub Repository](https://github.com/gtsteffaniak/filebrowser)

Documentation Best Practices

  • Keep descriptions brief: 40-60 characters for navigation cards
  • Use consistent icons: Related pages should use related icons
  • File structure matters: Order is determined by file system structure
  • Cross-reference: Add “Next Steps” section at the end

Local Preview

Always preview changes locally before submitting:

BASH 
1
2

cd docs
hugo server -D

Access at: http://localhost:1313/docs/

Next Steps