Files
meshcore-hub/docs/content.md

2.5 KiB

Custom Content

The web dashboard supports custom content including markdown pages and media files. Content is served from the CONTENT_HOME directory (default: ./content).

Directory Structure

content/
├── pages/     # Custom markdown pages
│   └── about.md
└── media/     # Custom media files
    └── images/
        ├── logo.svg          # Full-color custom logo (default)
        └── logo-invert.svg   # Monochrome custom logo (darkened in light mode)

Custom Logos

The web dashboard supports custom logo images placed in media/images/:

  • logo.svg — full-color logo, displayed as-is in both themes (no automatic darkening)
  • logo-invert.svg — monochrome/two-tone logo, automatically darkened in light mode for visibility

If no custom logos are provided, the default MeshCore Hub logos are used.

Markdown Pages

Custom pages are written in Markdown with optional YAML frontmatter for metadata. Pages automatically appear in the navigation menu and sitemap.

Setup

# Create content directory structure
mkdir -p content/pages content/media

# Create a custom page
cat > content/pages/about.md << 'EOF'
---
title: About Us
slug: about
menu_order: 10
---

# About Our Network

Welcome to our MeshCore mesh network!

## Getting Started

1. Get a compatible LoRa device
2. Flash MeshCore firmware
3. Configure your radio settings
EOF

Frontmatter Fields

Pages use YAML frontmatter for metadata:

---
title: About Us        # Browser tab title and nav link (not rendered on page)
slug: about            # URL path (default: filename without .md)
menu_order: 10         # Nav sort order (default: 100, lower = earlier)
---

# About Our Network

Markdown content here (include your own heading)...
Field Default Description
title Filename titlecased Browser tab title and navigation link text (not rendered on page)
slug Filename without .md URL path (e.g., about/pages/about)
menu_order 100 Sort order in navigation (lower = earlier)

The markdown content is rendered as-is, so include your own # Heading if desired.

Docker Configuration

With Docker, mount the content directory as a read-only volume. This is already configured in docker-compose.yml:

volumes:
  - ${CONTENT_HOME:-./content}:/content:ro
environment:
  - CONTENT_HOME=/content

To customize the content path, set CONTENT_HOME in your .env file:

# .env
CONTENT_HOME=./content