Skip to content

Commit d3e0f6d

Browse files
authored
Move from mkdocs to properdocs (#438)
since mkdocs is abandoned, move to the fork. See https://github.com/orgs/ProperDocs/discussions/33
1 parent bbe328b commit d3e0f6d

4 files changed

Lines changed: 31 additions & 10 deletions

File tree

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
uses: astral-sh/setup-uv@v7
2727

2828
- run: |
29-
uv run mkdocs build
29+
uv run properdocs build
3030
uv run python news2rss.py -f site/news/index.html -o site/news.xml
3131
3232
- name: Upload for pages

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
## Overview
1717

1818
This website is written in Markdown and gets built to a static website using
19-
[mkdocs](https://www.mkdocs.org/) and a modified version of the [mkdocs-material
19+
[properdocs](https://properdocs.org/) and a modified version of the [mkdocs-material
2020
theme](https://squidfunk.github.io/mkdocs-material). Any new commits to the
2121
`main` branch will auto deploy to [GitHub pages](https://pages.github.com) using
2222
[a GitHub action](https://github.com/actions/deploy-pages). The resulting
@@ -29,14 +29,14 @@ For small changes:
2929

3030
* Just use the online editor on GitHub and use the Markdown preview to inspect your changes
3131
* Open a PR with your changes in case you don't have commit rights
32-
* **Note:** The Markdown dialect and extensions understood by mkdocs and GitHub is
32+
* **Note:** The Markdown dialect and extensions understood by properdocs and GitHub is
3333
slightly different, so double check that the deployed website matches what you
3434
expected
3535
* **Note:** Every page on the website has a small "edit" icon in the top right corner which leads you straight to the online editor for that page
3636

3737
For larger changes:
3838

39-
* `uv run mkdocs serve`
39+
* `uv run properdocs serve`
4040
* Access http://127.0.0.1:8000 - any changes to the sources should be
4141
immediately visible in your browser
4242
* Open a PR with your changes or just push them if you have commit rights

pyproject.toml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,10 @@ version = "1.0"
44
description = ""
55
authors = [{ name = "Christoph Reiter", email = "reiter.christoph@gmail.com" }]
66
requires-python = ">=3.10,<4.0"
7-
dependencies = [
8-
]
97

108
[dependency-groups]
119
dev = [
12-
"mkdocs>=1.1.2,<2",
10+
"properdocs>=1.6.7,<2",
1311
"mkdocs-material>=9.5.0,<10",
1412
"mkdocs-redirects>=1.2.2",
1513
"beautifulsoup4>=4.13.4,<5",

uv.lock

Lines changed: 26 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)