peregrine/mkdocs.yml
pyr0ball 280f4271a5
Some checks failed
CI / Frontend (Vue) (push) Failing after 20s
CI / Backend (Python) (push) Failing after 1m13s
Mirror / mirror (push) Failing after 7s
feat: add Plausible analytics to Vue SPA and docs
2026-04-16 21:15:55 -07:00

75 lines
2.2 KiB
YAML

site_name: Peregrine
site_description: AI-powered job search pipeline
site_author: Circuit Forge LLC
site_url: https://docs.circuitforge.tech/peregrine
repo_url: https://git.opensourcesolarpunk.com/pyr0ball/peregrine
repo_name: pyr0ball/peregrine
theme:
name: material
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.top
- search.suggest
- search.highlight
- content.code.copy
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.tabbed:
alternate_style: true
- tables
- toc:
permalink: true
nav:
- Home: index.md
- Getting Started:
- Installation: getting-started/installation.md
- First-Run Wizard: getting-started/first-run-wizard.md
- Docker Profiles: getting-started/docker-profiles.md
- User Guide:
- Job Discovery: user-guide/job-discovery.md
- Job Review: user-guide/job-review.md
- Apply Workspace: user-guide/apply-workspace.md
- Interviews: user-guide/interviews.md
- Email Sync: user-guide/email-sync.md
- Integrations: user-guide/integrations.md
- Settings: user-guide/settings.md
- Developer Guide:
- Contributing: developer-guide/contributing.md
- Architecture: developer-guide/architecture.md
- Cloud Deployment: developer-guide/cloud-deployment.md
- Adding a Scraper: developer-guide/adding-scrapers.md
- Adding an Integration: developer-guide/adding-integrations.md
- Testing: developer-guide/testing.md
- Reference:
- Tier System: reference/tier-system.md
- LLM Router: reference/llm-router.md
- Config Files: reference/config-files.md
extra_javascript:
- plausible.js