From dc93f1c1fd7b67e2da5af2ffada732b9ddeb2d6a Mon Sep 17 00:00:00 2001 From: Kent Daleng Date: Sun, 17 Aug 2025 16:05:41 +0200 Subject: github wiki replacement / mkdocs-docs (#2147) * Add wiki based on mkdocs * wording fixes * fix github bg color on narrow * Fix left sidebar section headers being bigger than pages * fix hover accent * fix list rendering on fractional layout * fix videos * fix automatic full links * remove redundant commented css * improve dark mode contrast * update pygments for better child node coloring * update logo * remove blank lines * add systemd language hint --------- Co-authored-by: Ivan Molodetskikh --- docs/hooks/remove-must-fail.py | 19 ++++++++++++++++++ docs/hooks/shortcodes.py | 44 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 docs/hooks/remove-must-fail.py create mode 100644 docs/hooks/shortcodes.py (limited to 'docs/hooks') diff --git a/docs/hooks/remove-must-fail.py b/docs/hooks/remove-must-fail.py new file mode 100644 index 00000000..3284b10d --- /dev/null +++ b/docs/hooks/remove-must-fail.py @@ -0,0 +1,19 @@ +from __future__ import annotations +import re + +# todo: this could be done generically, so that any +# ```language,annotation,anything-else +# is reduced to +# ```language +# which is what's supported by mkdocs/pygments +# also note: mkdocs provides ways to highlight lines, add line numbers +# but these are added as +# ```language linenums="1" +# and not split by comma +def on_page_markdown( + markdown: str, *, page, config, files +): + return re.sub( + r",must-fail", + '', markdown, flags = re.I | re.M + ) \ No newline at end of file diff --git a/docs/hooks/shortcodes.py b/docs/hooks/shortcodes.py new file mode 100644 index 00000000..66f5c43e --- /dev/null +++ b/docs/hooks/shortcodes.py @@ -0,0 +1,44 @@ +# Copyright (c) 2016-2025 Martin Donath + +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: + +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. + +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. + +from __future__ import annotations +import re +from re import Match + +def on_page_markdown( + markdown: str, *, page, config, files +): + def replace(match: Match): + matches = match.groups() + preposition, version = matches[0], matches[1] + return _badge_for_version(preposition, version) + + return re.sub( + r"(Until|Since): (.*?)", + replace, markdown, flags = re.I | re.M + ) + +def _badge_for_version(preposition: str, version: str): + if version == "next release": + # we might fail to make real links to release notes on other cases too, but for now this is the one i've found + return f"{preposition}: {version}" + else: + path = f"https://github.com/YaLTeR/niri/releases/tag/v{version}" + return f"[{preposition}: {version}]({path})" -- cgit