Skip to content

Commit 0abf363

Browse files
authored
chore: add pre-commit hooks for mkdocs and markdownlint (#13)
* chore: add pre-commit hooks for mkdocs and markdownlint - Add .pre-commit-config.yaml with mkdocs build --strict and markdownlint - Add mkdocs dependencies to requirements-dev.txt - Fix broken link to PRESENTATION in quickstart.md - Update .claude/settings.local.json with mkdocs and pre-commit permissions * fix: add adr/README.md to mkdocs nav
1 parent bc0ca0f commit 0abf363

File tree

4 files changed

+25
-2
lines changed

4 files changed

+25
-2
lines changed

.pre-commit-config.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
repos:
2+
- repo: local
3+
hooks:
4+
- id: mkdocs-build
5+
name: mkdocs build --strict
6+
entry: .venv/bin/mkdocs build --strict
7+
language: system
8+
pass_filenames: false
9+
files: ^(docs/|mkdocs\.yml)
10+
11+
- repo: https://github.com/igorshubovych/markdownlint-cli
12+
rev: v0.43.0
13+
hooks:
14+
- id: markdownlint
15+
args: ["--fix"]
16+
exclude: ^\.claude/

docs/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,4 +107,4 @@ Read these to understand the format. Create your own based on your project.
107107
## Links
108108

109109
- **Working Demo**: [demo-fastapi](https://github.com/ambient-code/demo-fastapi)
110-
- **Presentation**: [PRESENTATION-ambient-code-reference.md](../PRESENTATION-ambient-code-reference.md)
110+
- **Presentation**: [PRESENTATION-ambient-code-reference.md](https://github.com/ambient-code/reference/blob/main/PRESENTATION-ambient-code-reference.md)

mkdocs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,9 @@ nav:
7373
- Foundation:
7474
- Security Patterns: patterns/security-patterns.md
7575
- Testing Patterns: patterns/testing-patterns.md
76-
- ADR Template: adr/template.md
76+
- ADR:
77+
- About ADRs: adr/README.md
78+
- Template: adr/template.md
7779

7880
extra:
7981
social:

requirements-dev.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,8 @@
22
black>=23.12.0
33
isort>=5.13.0
44
ruff>=0.1.0
5+
pre-commit>=3.6.0
6+
mkdocs>=1.6.0
7+
mkdocs-material>=9.5.0
8+
mkdocs-mermaid2-plugin>=1.1.0
9+
pymdown-extensions>=10.0.0

0 commit comments

Comments
 (0)