Merge pull request #303 from venthur/footnotes

Added footnotes

.github/workflows/python-package.yaml

@@ -1,12 +1,9 @@
-name: CI/CD Pipeline
-
 on:
   - push
   - pull_request
 
 jobs:
   test:
-    name: Test Python ${{ matrix.python-version }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
 
     strategy:
@@ -20,10 +17,12 @@ jobs:
           - "3.10"
           - "3.11"
           - "3.12"
+          - "3.13"
+          - "3.14"
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
-    - uses: actions/setup-python@v5
+    - uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -36,8 +35,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
-    - uses: actions/setup-python@v5
+    - uses: actions/setup-python@v6
       with:
         python-version: "3.x"
 
@@ -50,8 +49,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
-    - uses: actions/setup-python@v5
+    - uses: actions/setup-python@v6
       with:
         python-version: "3.x"
 
@@ -65,8 +64,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
-    - uses: actions/setup-python@v5
+    - uses: actions/setup-python@v6
       with:
         python-version: "3.x"
 

.readthedocs.yaml

@@ -3,13 +3,13 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.11"
+    python: "3.12"
 
 mkdocs:
   configuration: mkdocs.yml
 
 python:
   install:
-  - requirements: requirements.txt
-  - requirements: requirements-dev.txt
     - path: .
+      extra_requirements:
+        - dev

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [unreleased] --
+
+* Added Python 3.14 compatibility
+* Removed requirements.txt and requirements-dev.txt
+* Added footnotes extension for markdown
+
+## [2.3.3] -- 2025-04-27
+
+* Fixed Atom feed encoding to 'utf-8'
+* Added Python 3.13 to github actions
+* `requirements*.txt` files are handled by pip-tools. Updates are handled by
+  make update-requirements based on the dependencies described in the
+  pyproject.toml
+
 ## [2.3.2] -- 2024-10-13
 
 * Ignore FileNotFoundError when trying to get the last modified time of files

Makefile

@@ -16,11 +16,9 @@ endif
 .PHONY: all
 all: lint mypy test test-release
 
-$(VENV): requirements.txt requirements-dev.txt pyproject.toml
+$(VENV): pyproject.toml
 	$(PY) -m venv $(VENV)
-	$(BIN)/pip install --upgrade -r requirements.txt
+	$(BIN)/pip install --upgrade -e .['dev']
-	$(BIN)/pip install --upgrade -r requirements-dev.txt
-	$(BIN)/pip install -e .['dev']
 	touch $(VENV)
 
 .PHONY: test

README.md

@@ -21,6 +21,7 @@ blag is named after [the blag of the webcomic xkcd][blagxkcd].
 * Theming support using [Jinja2][] templates
 * Generation of Atom feeds for blog content
 * Fenced code blocks and syntax highlighting using [Pygments][]
+* Markdown footnotes
 * Integrated devserver
 * Available on [PyPI][]
 

blag/blag.py

@@ -396,7 +396,7 @@ def generate_feed(
         )
 
     with open(f"{output_dir}/atom.xml", "w") as fh:
-        feed.write(fh, encoding="utf8")
+        feed.write(fh, encoding='utf-8')
 
 
 def generate_index(

blag/markdown.py

@@ -34,6 +34,7 @@ def markdown_factory() -> Markdown:
             "fenced_code",
             "codehilite",
             "smarty",
+            "footnotes",
             MarkdownLinkExtension(),
         ],
         output_format="html",

blag/static/code-dark.css

@@ -5,80 +5,80 @@ td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5
 span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 .hll { background-color: #49483e }
 .c { color: #959077 } /* Comment */
-.err { color: #ed007e; background-color: #1e0010 } /* Error */
+.err { color: #ED007E; background-color: #1E0010 } /* Error */
-.esc { color: #f8f8f2 } /* Escape */
+.esc { color: #F8F8F2 } /* Escape */
-.g { color: #f8f8f2 } /* Generic */
+.g { color: #F8F8F2 } /* Generic */
-.k { color: #66d9ef } /* Keyword */
+.k { color: #66D9EF } /* Keyword */
-.l { color: #ae81ff } /* Literal */
+.l { color: #AE81FF } /* Literal */
-.n { color: #f8f8f2 } /* Name */
+.n { color: #F8F8F2 } /* Name */
-.o { color: #ff4689 } /* Operator */
+.o { color: #FF4689 } /* Operator */
-.x { color: #f8f8f2 } /* Other */
+.x { color: #F8F8F2 } /* Other */
-.p { color: #f8f8f2 } /* Punctuation */
+.p { color: #F8F8F2 } /* Punctuation */
 .ch { color: #959077 } /* Comment.Hashbang */
 .cm { color: #959077 } /* Comment.Multiline */
 .cp { color: #959077 } /* Comment.Preproc */
 .cpf { color: #959077 } /* Comment.PreprocFile */
 .c1 { color: #959077 } /* Comment.Single */
 .cs { color: #959077 } /* Comment.Special */
-.gd { color: #ff4689 } /* Generic.Deleted */
+.gd { color: #FF4689 } /* Generic.Deleted */
-.ge { color: #f8f8f2; font-style: italic } /* Generic.Emph */
+.ge { color: #F8F8F2; font-style: italic } /* Generic.Emph */
-.ges { color: #f8f8f2; font-weight: bold; font-style: italic } /* Generic.EmphStrong */
+.ges { color: #F8F8F2; font-weight: bold; font-style: italic } /* Generic.EmphStrong */
-.gr { color: #f8f8f2 } /* Generic.Error */
+.gr { color: #F8F8F2 } /* Generic.Error */
-.gh { color: #f8f8f2 } /* Generic.Heading */
+.gh { color: #F8F8F2 } /* Generic.Heading */
-.gi { color: #a6e22e } /* Generic.Inserted */
+.gi { color: #A6E22E } /* Generic.Inserted */
-.go { color: #66d9ef } /* Generic.Output */
+.go { color: #66D9EF } /* Generic.Output */
-.gp { color: #ff4689; font-weight: bold } /* Generic.Prompt */
+.gp { color: #FF4689; font-weight: bold } /* Generic.Prompt */
-.gs { color: #f8f8f2; font-weight: bold } /* Generic.Strong */
+.gs { color: #F8F8F2; font-weight: bold } /* Generic.Strong */
 .gu { color: #959077 } /* Generic.Subheading */
-.gt { color: #f8f8f2 } /* Generic.Traceback */
+.gt { color: #F8F8F2 } /* Generic.Traceback */
-.kc { color: #66d9ef } /* Keyword.Constant */
+.kc { color: #66D9EF } /* Keyword.Constant */
-.kd { color: #66d9ef } /* Keyword.Declaration */
+.kd { color: #66D9EF } /* Keyword.Declaration */
-.kn { color: #ff4689 } /* Keyword.Namespace */
+.kn { color: #FF4689 } /* Keyword.Namespace */
-.kp { color: #66d9ef } /* Keyword.Pseudo */
+.kp { color: #66D9EF } /* Keyword.Pseudo */
-.kr { color: #66d9ef } /* Keyword.Reserved */
+.kr { color: #66D9EF } /* Keyword.Reserved */
-.kt { color: #66d9ef } /* Keyword.Type */
+.kt { color: #66D9EF } /* Keyword.Type */
-.ld { color: #e6db74 } /* Literal.Date */
+.ld { color: #E6DB74 } /* Literal.Date */
-.m { color: #ae81ff } /* Literal.Number */
+.m { color: #AE81FF } /* Literal.Number */
-.s { color: #e6db74 } /* Literal.String */
+.s { color: #E6DB74 } /* Literal.String */
-.na { color: #a6e22e } /* Name.Attribute */
+.na { color: #A6E22E } /* Name.Attribute */
-.nb { color: #f8f8f2 } /* Name.Builtin */
+.nb { color: #F8F8F2 } /* Name.Builtin */
-.nc { color: #a6e22e } /* Name.Class */
+.nc { color: #A6E22E } /* Name.Class */
-.no { color: #66d9ef } /* Name.Constant */
+.no { color: #66D9EF } /* Name.Constant */
-.nd { color: #a6e22e } /* Name.Decorator */
+.nd { color: #A6E22E } /* Name.Decorator */
-.ni { color: #f8f8f2 } /* Name.Entity */
+.ni { color: #F8F8F2 } /* Name.Entity */
-.ne { color: #a6e22e } /* Name.Exception */
+.ne { color: #A6E22E } /* Name.Exception */
-.nf { color: #a6e22e } /* Name.Function */
+.nf { color: #A6E22E } /* Name.Function */
-.nl { color: #f8f8f2 } /* Name.Label */
+.nl { color: #F8F8F2 } /* Name.Label */
-.nn { color: #f8f8f2 } /* Name.Namespace */
+.nn { color: #F8F8F2 } /* Name.Namespace */
-.nx { color: #a6e22e } /* Name.Other */
+.nx { color: #A6E22E } /* Name.Other */
-.py { color: #f8f8f2 } /* Name.Property */
+.py { color: #F8F8F2 } /* Name.Property */
-.nt { color: #ff4689 } /* Name.Tag */
+.nt { color: #FF4689 } /* Name.Tag */
-.nv { color: #f8f8f2 } /* Name.Variable */
+.nv { color: #F8F8F2 } /* Name.Variable */
-.ow { color: #ff4689 } /* Operator.Word */
+.ow { color: #FF4689 } /* Operator.Word */
-.pm { color: #f8f8f2 } /* Punctuation.Marker */
+.pm { color: #F8F8F2 } /* Punctuation.Marker */
-.w { color: #f8f8f2 } /* Text.Whitespace */
+.w { color: #F8F8F2 } /* Text.Whitespace */
-.mb { color: #ae81ff } /* Literal.Number.Bin */
+.mb { color: #AE81FF } /* Literal.Number.Bin */
-.mf { color: #ae81ff } /* Literal.Number.Float */
+.mf { color: #AE81FF } /* Literal.Number.Float */
-.mh { color: #ae81ff } /* Literal.Number.Hex */
+.mh { color: #AE81FF } /* Literal.Number.Hex */
-.mi { color: #ae81ff } /* Literal.Number.Integer */
+.mi { color: #AE81FF } /* Literal.Number.Integer */
-.mo { color: #ae81ff } /* Literal.Number.Oct */
+.mo { color: #AE81FF } /* Literal.Number.Oct */
-.sa { color: #e6db74 } /* Literal.String.Affix */
+.sa { color: #E6DB74 } /* Literal.String.Affix */
-.sb { color: #e6db74 } /* Literal.String.Backtick */
+.sb { color: #E6DB74 } /* Literal.String.Backtick */
-.sc { color: #e6db74 } /* Literal.String.Char */
+.sc { color: #E6DB74 } /* Literal.String.Char */
-.dl { color: #e6db74 } /* Literal.String.Delimiter */
+.dl { color: #E6DB74 } /* Literal.String.Delimiter */
-.sd { color: #e6db74 } /* Literal.String.Doc */
+.sd { color: #E6DB74 } /* Literal.String.Doc */
-.s2 { color: #e6db74 } /* Literal.String.Double */
+.s2 { color: #E6DB74 } /* Literal.String.Double */
-.se { color: #ae81ff } /* Literal.String.Escape */
+.se { color: #AE81FF } /* Literal.String.Escape */
-.sh { color: #e6db74 } /* Literal.String.Heredoc */
+.sh { color: #E6DB74 } /* Literal.String.Heredoc */
-.si { color: #e6db74 } /* Literal.String.Interpol */
+.si { color: #E6DB74 } /* Literal.String.Interpol */
-.sx { color: #e6db74 } /* Literal.String.Other */
+.sx { color: #E6DB74 } /* Literal.String.Other */
-.sr { color: #e6db74 } /* Literal.String.Regex */
+.sr { color: #E6DB74 } /* Literal.String.Regex */
-.s1 { color: #e6db74 } /* Literal.String.Single */
+.s1 { color: #E6DB74 } /* Literal.String.Single */
-.ss { color: #e6db74 } /* Literal.String.Symbol */
+.ss { color: #E6DB74 } /* Literal.String.Symbol */
-.bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */
+.bp { color: #F8F8F2 } /* Name.Builtin.Pseudo */
-.fm { color: #a6e22e } /* Name.Function.Magic */
+.fm { color: #A6E22E } /* Name.Function.Magic */
-.vc { color: #f8f8f2 } /* Name.Variable.Class */
+.vc { color: #F8F8F2 } /* Name.Variable.Class */
-.vg { color: #f8f8f2 } /* Name.Variable.Global */
+.vg { color: #F8F8F2 } /* Name.Variable.Global */
-.vi { color: #f8f8f2 } /* Name.Variable.Instance */
+.vi { color: #F8F8F2 } /* Name.Variable.Instance */
-.vm { color: #f8f8f2 } /* Name.Variable.Magic */
+.vm { color: #F8F8F2 } /* Name.Variable.Magic */
-.il { color: #ae81ff } /* Literal.Number.Integer.Long */
+.il { color: #AE81FF } /* Literal.Number.Integer.Long */

blag/static/code-light.css

@@ -5,9 +5,9 @@ td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5
 span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 .hll { background-color: #ffffcc }
 .c { color: #3D7B7B; font-style: italic } /* Comment */
-.err { border: 1px solid #FF0000 } /* Error */
+.err { border: 1px solid #F00 } /* Error */
 .k { color: #008000; font-weight: bold } /* Keyword */
-.o { color: #666666 } /* Operator */
+.o { color: #666 } /* Operator */
 .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */
 .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */
 .cp { color: #9C6500 } /* Comment.Preproc */
@@ -24,34 +24,34 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
 .gs { font-weight: bold } /* Generic.Strong */
 .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
-.gt { color: #0044DD } /* Generic.Traceback */
+.gt { color: #04D } /* Generic.Traceback */
 .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
 .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
 .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
 .kp { color: #008000 } /* Keyword.Pseudo */
 .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
 .kt { color: #B00040 } /* Keyword.Type */
-.m { color: #666666 } /* Literal.Number */
+.m { color: #666 } /* Literal.Number */
 .s { color: #BA2121 } /* Literal.String */
 .na { color: #687822 } /* Name.Attribute */
 .nb { color: #008000 } /* Name.Builtin */
-.nc { color: #0000FF; font-weight: bold } /* Name.Class */
+.nc { color: #00F; font-weight: bold } /* Name.Class */
-.no { color: #880000 } /* Name.Constant */
+.no { color: #800 } /* Name.Constant */
-.nd { color: #AA22FF } /* Name.Decorator */
+.nd { color: #A2F } /* Name.Decorator */
 .ni { color: #717171; font-weight: bold } /* Name.Entity */
 .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
-.nf { color: #0000FF } /* Name.Function */
+.nf { color: #00F } /* Name.Function */
 .nl { color: #767600 } /* Name.Label */
-.nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
+.nn { color: #00F; font-weight: bold } /* Name.Namespace */
 .nt { color: #008000; font-weight: bold } /* Name.Tag */
 .nv { color: #19177C } /* Name.Variable */
-.ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
+.ow { color: #A2F; font-weight: bold } /* Operator.Word */
-.w { color: #bbbbbb } /* Text.Whitespace */
+.w { color: #BBB } /* Text.Whitespace */
-.mb { color: #666666 } /* Literal.Number.Bin */
+.mb { color: #666 } /* Literal.Number.Bin */
-.mf { color: #666666 } /* Literal.Number.Float */
+.mf { color: #666 } /* Literal.Number.Float */
-.mh { color: #666666 } /* Literal.Number.Hex */
+.mh { color: #666 } /* Literal.Number.Hex */
-.mi { color: #666666 } /* Literal.Number.Integer */
+.mi { color: #666 } /* Literal.Number.Integer */
-.mo { color: #666666 } /* Literal.Number.Oct */
+.mo { color: #666 } /* Literal.Number.Oct */
 .sa { color: #BA2121 } /* Literal.String.Affix */
 .sb { color: #BA2121 } /* Literal.String.Backtick */
 .sc { color: #BA2121 } /* Literal.String.Char */
@@ -66,9 +66,9 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .s1 { color: #BA2121 } /* Literal.String.Single */
 .ss { color: #19177C } /* Literal.String.Symbol */
 .bp { color: #008000 } /* Name.Builtin.Pseudo */
-.fm { color: #0000FF } /* Name.Function.Magic */
+.fm { color: #00F } /* Name.Function.Magic */
 .vc { color: #19177C } /* Name.Variable.Class */
 .vg { color: #19177C } /* Name.Variable.Global */
 .vi { color: #19177C } /* Name.Variable.Instance */
 .vm { color: #19177C } /* Name.Variable.Magic */
-.il { color: #666666 } /* Literal.Number.Integer.Long */
+.il { color: #666 } /* Literal.Number.Integer.Long */

blag/static/style.css

@@ -1,32 +1,15 @@
 @import "code-light.css" (prefers-color-scheme: light);
 @import "code-dark.css" (prefers-color-scheme: dark);
 
-@media (prefers-color-scheme: light) {
 :root {
-        --background: #FFFFFF;
+    color-scheme: light dark;
-        --background-dim: #f5f7f9;
+    --background: light-dark(#FFFFFF, #2B363B);
-
+    --background-dim: light-dark(#f5f7f9, #2F3C42);
-        --foreground: #2B303A;
+    --foreground: light-dark(#2B303A, #f0f2f3);
-        --foreground-dim: #576379;
+    --foreground-dim: light-dark(#576379, #d5d5d5);
-        --foreground-heavy: #191C22;
+    --foreground-heavy: light-dark(#191C22, #f2f4f5);
-
+    --primary-color: light-dark(#375287, #A1C5FF);
-        --primary-color: #375287;
 }
-}
-
-@media (prefers-color-scheme: dark) {
-    :root {
-        --background: #2B363B;
-        --background-dim: #2F3C42;
-
-        --foreground: #f0f2f3;
-        --foreground-dim: #d5d5d5;
-        --foreground-heavy: #f2f4f5;
-
-        --primary-color: #A1C5FF;
-    }
-}
-
 
 html {
   font-size: 18px;
@@ -168,3 +151,10 @@ header h2 {
   display: inline;
   font-size: 1.2rem;
 }
+
+hr {
+  border: none;
+  border-top: 1px solid var(--foreground-dim);
+  opacity: 0.3;
+  margin: 2rem 0;
+}

blag/version.py

@@ -1,3 +1,3 @@
 """Version information for the blag package."""
 
-__VERSION__ = "2.3.2"
+__VERSION__ = "2.3.3"

debian/changelog

@@ -1,3 +1,13 @@
+blag (2.3.3) unstable; urgency=medium
+
+  * Fixed Atom feed encoding to 'utf-8'
+  * Added Python 3.13 to github actions
+  * `requirements*.txt` files are handled by pip-tools. Updates are handled by
+    make update-requirements based on the dependencies described in the
+    pyproject.toml
+
+ -- Bastian Venthur <venthur@debian.org>  Sun, 27 Apr 2025 11:42:13 +0200
+
 blag (2.3.2) unstable; urgency=medium
 
   * Ignore FileNotFoundError when trying to get the last modified time of

pyproject.toml

@@ -10,13 +10,13 @@ authors = [
 description = "blog-aware, static site generator"
 keywords = ["markdown", "blag", "blog", "static site generator", "cli"]
 readme = "README.md"
-license = { file="LICENSE" }
+license-files = ["LICENSE"]
 requires-python = ">=3.10"
 dynamic = ["version"]
 dependencies = [
-    "markdown",
     "feedgenerator",
     "jinja2",
+    "markdown",
     "pygments",
 ]
 
@@ -34,13 +34,13 @@ dev = [
     "mkdocs",
     "mkdocs-material",
     "mkdocstrings[python]",
-    "twine",
+    "mypy",
-    "wheel",
     "pytest",
     "pytest-cov",
     "ruff",
-    "mypy",
+    "twine",
     "types-markdown",
+    "wheel",
 ]
 
 [tool.setuptools.dynamic]

requirements-dev.txt

@@ -1,11 +0,0 @@
-build==1.2.2.post1
-mkdocs==1.6.1
-mkdocs-material==9.5.39
-mkdocstrings[python]==0.26.1
-twine==5.1.1
-wheel==0.44.0
-pytest==8.3.3
-pytest-cov==5.0.0
-ruff==0.6.9
-mypy==1.11.2
-types-markdown==3.7.0.20240822

requirements.txt

@@ -1,4 +0,0 @@
-markdown==3.7
-feedgenerator==2.1.0
-jinja2==3.1.4
-pygments==2.18.0

tests/test_blag.py

@@ -99,6 +99,15 @@ def test_generate_feed_with_description(cleandir: str) -> None:
     assert '<content type="html">content' in feed
 
 
+def test_feed_is_unicode(cleandir: str) -> None:
+    """Test generate_feed."""
+    articles: list[tuple[str, dict[str, Any]]] = []
+    blag.generate_feed(articles, "build", " ", " ", " ", " ")
+    with open("build/atom.xml") as fh:
+        feed = fh.read()
+    assert 'encoding="utf-8"' in feed
+
+
 def test_parse_args_build() -> None:
     """Test parse_args with build."""
     # test default args

tests/test_markdown.py

@@ -111,3 +111,17 @@ this --- is -- a test ...
     assert "mdash" not in html
     assert "ndash" not in html
     assert "hellip" not in html
+
+
+def test_footnotes() -> None:
+    """Test footnote extension."""
+    md = markdown_factory()
+    md1 = """
+this is a footnote[^1]
+
+[^1]: this is the footnotetext
+"""
+    html, meta = convert_markdown(md, md1)
+    assert "<hr>" in html
+    assert "<ol>" in html
+    assert "footnotetext" in html