moneyflow/mkdocs.yml at main · wesm/moneyflow · 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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
site_name: moneyflow
site_url: https://moneyflow.dev
site_author: Wes McKinney
site_description: Track your moneyflow - A powerful terminal UI for personal finance management
repo_url: https://github.com/wesm/moneyflow
repo_name: wesm/moneyflow
edit_uri: edit/main/docs/
copyright: Copyright &copy; 2025 Wes McKinney

theme:
  name: material
  palette:
    # Dark theme (default for terminal users)
    - scheme: slate
      primary: indigo
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    # Light theme
    - scheme: default
      primary: indigo
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

  font:
    text: Roboto
    code: Roboto Mono

  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link

  icon:
    repo: fontawesome/brands/github
    logo: material/currency-usd

  # Show star count in header
  custom_dir: docs/overrides

extra_css:
  - stylesheets/extra.css
  - stylesheets/terminal.css

extra_javascript:
  - javascripts/lightbox.js

extra:
  version: "0.9.1"
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/wesm/moneyflow
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/moneyflow/

  # Analytics disabled for now
  # analytics:
  #   provider: google
  #   property: G-XXXXXXXXXX

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - tables
  - footnotes
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde

plugins:
  - search:
      lang: en
  # - social  # Disabled - requires imaging dependencies (cairosvg, PIL)

# Watch additional directories for live reload during development
watch:
  - docs/assets/screenshots

nav:
  - Home:
    - Overview: index.md
    - Quick Start: getting-started/quickstart.md
    - Changelog: reference/changelog.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
  - User Guide:
    - Navigation & Search: guide/navigation.md
    - Editing Transactions: guide/editing.md
    - Filters: guide/filters.md
    - Keyboard Shortcuts: guide/keyboard-shortcuts.md
    - Monarch Money: guide/monarch.md
    - YNAB: guide/ynab.md
    - Amazon Mode: guide/amazon-mode.md
  - Configuration:
    - Themes: config/themes.md
    - Categories: categories.md
    - Caching: config/caching.md
    - Advanced Options: config/advanced.md
  - Reference:
    - CLI Options: reference/cli.md
    - Troubleshooting: reference/troubleshooting.md
    - FAQ: reference/faq.md
  - Development:
    - Developing moneyflow: development/developing.md
    - Contributing: development/contributing.md
    - Architecture: development/architecture.md