Skip to content

Commit 581a5b7

Browse files
committed
Zensical with uv setup alongside existing MkDocs documentation. Uppgrade
Python to 3.11
1 parent 80dc4a3 commit 581a5b7

File tree

5 files changed

+191
-1
lines changed

5 files changed

+191
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ site/
33
overrides/
44
.obsidian/
55
.DS_Store
6+
trace.json

.python-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.10
1+
3.11

CLAUDE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ This is the gitStream repository - a workflow automation tool for git repositori
99
## Development Commands
1010

1111
### Documentation Server
12+
13+
#### MkDocs (Current/Production)
1214
The documentation is built using MkDocs Material theme.
1315

1416
```bash
@@ -26,6 +28,27 @@ mkdocs serve # Runs at http://127.0.0.1:8000/
2628
mkdocs build
2729
```
2830

31+
#### Zensical (Testing)
32+
Zensical is being evaluated as a potential replacement for MkDocs. It uses the same `mkdocs.yml` configuration file.
33+
34+
**Requirements:** Python 3.11+ (uses `uv` for dependency management)
35+
36+
```bash
37+
# Sync/install Zensical dependencies (first time or after updates)
38+
uv sync
39+
40+
# Run Zensical documentation server locally
41+
uv run zensical serve # Runs at http://127.0.0.1:8000/
42+
43+
# Build documentation with Zensical
44+
uv run zensical build
45+
```
46+
47+
**Notes:**
48+
- Zensical uses its own uv-managed virtual environment (`.venv`) with Python 3.11+
49+
- Both MkDocs and Zensical use port 8000 by default, so run only one at a time
50+
- See `ZENSICAL_TESTING.md` for detailed comparison guide
51+
2952
## Code Architecture
3053

3154
### Project Structure

pyproject.toml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[project]
2+
name = "gitstream"
3+
version = "0.1.0"
4+
description = "gitStream documentation"
5+
requires-python = ">=3.11"
6+
dependencies = [
7+
"zensical>=0.0.3",
8+
]

0 commit comments

Comments
 (0)