Skip to main content

GitHub Pages Setup Guide (Deprecated)

⚠️ Note: This guide is deprecated. Documentation is now deployed to a unified Cloudflare Pages site.

Current Setup​

Documentation is now managed through the unified FishingLog.Documentation repository and deployed to Cloudflare Pages with password protection.

See DOCUSAURUS_UNIFIED_SETUP.md for the current documentation setup.

Local Development​

You can still use MkDocs locally for development:

# Install MkDocs
pip install mkdocs mkdocs-material mkdocs-awesome-pages-plugin

# Serve locally
mkdocs serve

# Build locally (for testing)
mkdocs build

The mkdocs.yml file is still maintained for local development purposes.

Migration Notes​

  • Old: Documentation deployed to GitHub Pages (gh-pages branch)
  • New: Documentation deployed to Cloudflare Pages via unified repo
  • Benefits: Password protection, unified site, better multi-repo support

For current documentation setup, see: DOCUSAURUS_UNIFIED_SETUP.md