Skip to content

Commit 865550e

Browse files
wesmclaude
andcommitted
docs: Add mkdocs live reload instructions for documentation development
Added instructions for running mkdocs with --livereload flag to enable automatic browser refresh when editing documentation files. Without --livereload, mkdocs serve runs but doesn't auto-refresh the browser when files change, requiring manual page refreshes. Added to docs/development/developing.md in new "Working on Documentation" section with clear note about the importance of the --livereload flag. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 2abf103 commit 865550e

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

docs/development/developing.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,20 @@ uv run pyright moneyflow/
3636

3737
## Development Workflow
3838

39+
### Working on Documentation
40+
41+
To preview documentation changes locally with live reload:
42+
43+
```bash
44+
# Serve docs with live reload (auto-refreshes on file changes)
45+
uv run mkdocs serve --livereload
46+
47+
# Then open http://127.0.0.1:8000 in your browser
48+
# Edit files in docs/ and see changes instantly
49+
```
50+
51+
**Note:** The `--livereload` flag is important - without it, changes won't auto-refresh in the browser.
52+
3953
### Before Starting Work
4054

4155
```bash

docs/index.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
# moneyflow
1+
# moneyflow [![GitHub stars](https://img.shields.io/github/stars/wesm/moneyflow?style=social)](https://github.com/wesm/moneyflow/stargazers)
22

33
**Terminal UI for personal finance power users**
44

5-
Track spending, bulk edit transactions, and navigate your financial data at lightning speed. Supports personal finance platforms like Monarch Money or even analyzing your Amazon purchase history.
6-
7-
[![GitHub stars](https://img.shields.io/github/stars/wesm/moneyflow?style=social)](https://github.com/wesm/moneyflow/stargazers)
5+
![moneyflow terminal UI](https://raw.githubusercontent.com/wesm-ursalabs/moneyflow-assets/main/home-screen.png)
86

97
```bash
108
# Install and run
@@ -16,7 +14,7 @@ uvx moneyflow
1614
uvx moneyflow --demo # Try with demo data
1715
```
1816

19-
![moneyflow terminal UI](images/home-screen.png)
17+
Track spending, bulk edit transactions, and navigate your financial data at lightning speed. Supports personal finance platforms like Monarch Money or even analyzing your Amazon purchase history.
2018

2119
<div class="quick-links" markdown>
2220
[Get Started](getting-started/installation.md){ .md-button .md-button--primary }

0 commit comments

Comments
 (0)