fastapi-react-starter/mkdocs.yml at main · raythurman2386/fastapi-react-starter · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
site_name: FastAPI React Starter Docs
site_url: https://raythurman2386.github.io/fastapi-react-starter/

nav:
  - Home: index.md
  - Initial Setup: initial_setup.md
  - Development: development.md
  - Frontend Guides:
    - Tailwind CSS v4: frontend/tailwind-v4.md
    - Shadcn UI: frontend/shadcn-ui.md
  - Backend Guides:
    - FastAPI Overview: backend/fastapi-guide.md
    - Alembic Migrations: backend/alembic-migrations.md
  - Make it Yours: make_it_yours.md
  - Deployment: deployment.md
  - Roadmap: roadmap.md

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - toc.integrate
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy

plugins:
  - search

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - toc:
      permalink: true


# Explicitly point to the current directory for markdown files
docs_dir: docs