followcursor/mkdocs.yml at main · sabbour/followcursor · 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
61
62
63
64
65
66
67
68
69
70
site_name: FollowCursor
site_description: Windows screen recorder with cinematic cursor-following zoom
site_url: https://sabbour.me/followcursor
repo_url: https://github.com/sabbour/followcursor
repo_name: sabbour/followcursor

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: purple
      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
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - macros:
      module_name: docs/hooks/main

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - docs/overrides/.icons

nav:
  - Home: index.md
  - Getting Started: QUICKSTART.md
  - User Guide:
    - Recording: user-guide/recording.md
    - Zoom & Pan: user-guide/zoom.md
    - Visual Customization: user-guide/customization.md
    - AI Features: user-guide/ai.md
    - Export: user-guide/export.md
    - Project Files: user-guide/projects.md
    - Keyboard Shortcuts: user-guide/shortcuts.md
  - Architecture: ARCHITECTURE.md
  - Contributing: CONTRIBUTING.md