Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
uses: astral-sh/setup-uv@v7

- run: |
uv run mkdocs build
uv run properdocs build
uv run python news2rss.py -f site/news/index.html -o site/news.xml

- name: Upload for pages
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
## Overview

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

* Just use the online editor on GitHub and use the Markdown preview to inspect your changes
* Open a PR with your changes in case you don't have commit rights
* **Note:** The Markdown dialect and extensions understood by mkdocs and GitHub is
* **Note:** The Markdown dialect and extensions understood by properdocs and GitHub is
slightly different, so double check that the deployed website matches what you
expected
* **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

For larger changes:

* `uv run mkdocs serve`
* `uv run properdocs serve`
* Access http://127.0.0.1:8000 - any changes to the sources should be
immediately visible in your browser
* Open a PR with your changes or just push them if you have commit rights
Expand Down
4 changes: 1 addition & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,10 @@ version = "1.0"
description = ""
authors = [{ name = "Christoph Reiter", email = "reiter.christoph@gmail.com" }]
requires-python = ">=3.10,<4.0"
dependencies = [
]

[dependency-groups]
dev = [
"mkdocs>=1.1.2,<2",
"properdocs>=1.6.7,<2",
"mkdocs-material>=9.5.0,<10",
"mkdocs-redirects>=1.2.2",
"beautifulsoup4>=4.13.4,<5",
Expand Down
29 changes: 26 additions & 3 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading