Initial commit

Author: tmaegel

Diff for: .gitignore

@@ -0,0 +1,4 @@
+__pycache__
+output
+content/
+venv

Diff for: Makefile

@@ -0,0 +1,66 @@
+PY?=
+PELICAN?=pelican
+PELICANOPTS=
+
+BASEDIR=$(CURDIR)
+INPUTDIR=$(BASEDIR)/content
+OUTPUTDIR=$(BASEDIR)/output
+CONFFILE=$(BASEDIR)/pelicanconf.py
+PUBLISHCONF=$(BASEDIR)/publishconf.py
+
+
+DEBUG ?= 0
+ifeq ($(DEBUG), 1)
+	PELICANOPTS += -D
+endif
+
+RELATIVE ?= 0
+ifeq ($(RELATIVE), 1)
+	PELICANOPTS += --relative-urls
+endif
+
+SERVER ?= "0.0.0.0"
+
+PORT ?= 0
+ifneq ($(PORT), 0)
+	PELICANOPTS += -p $(PORT)
+endif
+
+
+help:
+	@echo 'Makefile for a pelican Web site                                           '
+	@echo '                                                                          '
+	@echo 'Usage:                                                                    '
+	@echo '   make html                           (re)generate the web site          '
+	@echo '   make clean                          remove the generated files         '
+	@echo '   make regenerate                     regenerate files upon modification '
+	@echo '   make publish                        generate using production settings '
+	@echo '   make serve [PORT=8000]              serve site at http://localhost:8000'
+	@echo '   make devserver [PORT=8000]          serve and regenerate together      '
+	@echo '                                                                          '
+	@echo 'Set the DEBUG variable to 1 to enable debugging, e.g. make DEBUG=1 html   '
+	@echo 'Set the RELATIVE variable to 1 to enable relative urls                    '
+	@echo '                                                                          '
+
+html:
+	"$(PELICAN)" "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS)
+
+clean:
+	[ ! -d "$(OUTPUTDIR)" ] || rm -rf "$(OUTPUTDIR)"
+
+regenerate:
+	"$(PELICAN)" -r "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS)
+
+serve:
+	"$(PELICAN)" -l "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS)
+
+devserver:
+	"$(PELICAN)" -lr "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS)
+
+publish:
+	"$(PELICAN)" "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(PUBLISHCONF)" $(PELICANOPTS)
+
+install_venv:
+	pip-sync requirements.txt requirements_dev.txt
+
+.PHONY: html help clean regenerate serve serve-global devserver publish

Diff for: pelicanconf.py

@@ -0,0 +1,59 @@
+AUTHOR = "Toni Mägel"
+SITENAME = "tonimaegel.de"
+SITEURL = ""
+
+PATH = "content"
+
+TIMEZONE = "Europe/Berlin"
+
+DEFAULT_LANG = "de"
+
+# Uncomment following line if you want document-relative URLs when developing
+# Can be useful in development, but set to False when you're ready to publish
+# RELATIVE_URLS = True
+
+# Feed generation is usually not desired when developing
+FEED_ALL_ATOM = None
+CATEGORY_FEED_ATOM = None
+TRANSLATION_FEED_ATOM = None
+AUTHOR_FEED_ATOM = None
+AUTHOR_FEED_RSS = None
+
+# Blogroll
+LINKS = ()
+
+# Social widget
+SOCIAL = (
+    ("github", "https://github.com/tmaegel/"),
+    ("linkedin", "https://de.linkedin.com/in/toni-maegel"),
+    ("envelope-fill", "mailto:[email protected]"),
+)
+
+GITHUB_URL = "https://github.com/tmaegel/"
+
+DISPLAY_CATEGORIES_ON_MENU = False
+DISPLAY_PAGES_ON_MENU = True
+MENUITEMS = (
+    ("Posts", "/index.html"),
+    ("Themen", "/categories.html"),
+    ("Tags", "/tags.html"),
+)
+
+DEFAULT_PAGINATION = 10
+
+PLUGIN_PATH = ["plugins"]
+PLUGINS = ["better_codeblock_line_numbering_fork"]
+
+MARKDOWN = {
+    "extension_configs": {
+        "markdown.extensions.codehilite": {
+            "css_class": "highlight",
+            "linenums": False,
+        },
+        "markdown.extensions.extra": {},
+        "markdown.extensions.meta": {},
+    },
+    "output_format": "html5",
+}
+
+THEME = "themes/custom"

Diff for: plugins/better_codeblock_line_numbering_fork/__init__.py

@@ -0,0 +1 @@
+from .better_codeblock_line_numbering import *

Diff for: plugins/better_codeblock_line_numbering_fork/better_codeblock_line_numbering.py

@@ -0,0 +1,69 @@
+import re
+
+from pelican import signals  # For making this plugin work with Pelican.
+
+
+def add_line_wrappers(content: str) -> str:
+    """
+    A function to read through each page and post as it comes through
+    from Pelican to find all instances of triple-backtick (```...```) code
+    blocks and add an html line wrapper to each line of each of those code
+    blocks.
+
+    <div class="highlight">
+        <pre>
+            <span></span>
+            <code>
+                codeline1
+                codeline2
+                codeline3
+            </code>
+        </pre>
+    </div>
+    """
+
+    pre_list = re.findall("<pre>.*?</pre>", content, re.DOTALL)
+
+    if not pre_list:
+        return content
+
+    for pre in pre_list:
+        pre_section = ["<pre>", "<code>"]
+        code = re.findall(
+            "<pre>\n?<span></span>\n?<code>(?P<code>.*?)</code>\n?</pre>",
+            pre,
+            re.DOTALL,
+        )
+        if len(code) != 1:
+            continue
+
+        lines = code[0].split("\n")
+        if not lines:
+            continue
+
+        # Remove first empty code line.
+        if len(lines) >= 1 and not lines[0]:
+            del lines[0]
+        # Remove last empty code line.
+        if len(lines) >= 1 and not lines[-1]:
+            del lines[-1]
+
+        for line in lines:
+            pre_section.append(f'<span class="code-line">{line}</span>')
+
+        pre_section.extend(["</code>", "</pre>"])
+        content = content.replace(pre, "\n".join(pre_section))
+
+    return content
+
+
+def main(input) -> None:
+    if input._content:
+        input._content = add_line_wrappers(input._content)
+    else:
+        # Exit the function, essentially passing over the (non-text) file.
+        return
+
+
+def register():
+    signals.content_object_init.connect(main)

Diff for: plugins/better_codeblock_line_numbering_fork/test_better_codeblock_line_numbering.py

@@ -0,0 +1,76 @@
+import pytest
+from better_codeblock_line_numbering_fork import add_line_wrappers
+
+
+@pytest.mark.parametrize(
+    "input, output",
+    [
+        (
+            ("<pre>\n" "<span></span>\n" "<code>\n" "echo\n" "</code>\n" "</pre>"),
+            (
+                "<pre>\n"
+                "<code>\n"
+                '<span class="code-line">echo</span>\n'
+                "</code>\n"
+                "</pre>"
+            ),
+        ),
+        (
+            ("<pre>\n" "<span></span><code>\n" "echo\n" "</code>\n" "</pre>"),
+            (
+                "<pre>\n"
+                "<code>\n"
+                '<span class="code-line">echo</span>\n'
+                "</code>\n"
+                "</pre>"
+            ),
+        ),
+        (
+            ("<pre><span></span><code>\n" "echo\n" "</code></pre>"),
+            (
+                "<pre>\n"
+                "<code>\n"
+                '<span class="code-line">echo</span>\n'
+                "</code>\n"
+                "</pre>"
+            ),
+        ),
+        (
+            ("<pre><span></span><code>echo</code></pre>"),
+            (
+                "<pre>\n"
+                "<code>\n"
+                '<span class="code-line">echo</span>\n'
+                "</code>\n"
+                "</pre>"
+            ),
+        ),
+        (
+            ("<pre><span></span><code>echo\n\necho</code></pre>"),
+            (
+                "<pre>\n"
+                "<code>\n"
+                '<span class="code-line">echo</span>\n'
+                '<span class="code-line"></span>\n'
+                '<span class="code-line">echo</span>\n'
+                "</code>\n"
+                "</pre>"
+            ),
+        ),
+        (
+            ("<pre><span></span><code>\n\necho\n\n</code></pre>"),
+            (
+                "<pre>\n"
+                "<code>\n"
+                '<span class="code-line"></span>\n'
+                '<span class="code-line">echo</span>\n'
+                '<span class="code-line"></span>\n'
+                "</code>\n"
+                "</pre>"
+            ),
+        ),
+    ],
+)
+def test_add_line_wrappers(input, output):
+    result = add_line_wrappers(input)
+    assert result == output

Diff for: publishconf.py

@@ -0,0 +1,21 @@
+# This file is only used if you use `make publish` or
+# explicitly specify it as your config file.
+
+import os
+import sys
+sys.path.append(os.curdir)
+from pelicanconf import *
+
+# If your site is available via HTTPS, make sure SITEURL begins with https://
+SITEURL = ''
+RELATIVE_URLS = False
+
+FEED_ALL_ATOM = 'feeds/all.atom.xml'
+CATEGORY_FEED_ATOM = 'feeds/{slug}.atom.xml'
+
+DELETE_OUTPUT_DIRECTORY = True
+
+# Following items are often useful when publishing
+
+#DISQUS_SITENAME = ""
+#GOOGLE_ANALYTICS = ""

Diff for: requirements.in

@@ -0,0 +1 @@
+pelican[markdown]

Diff for: requirements.txt

@@ -0,0 +1,40 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile requirements.in
+#
+blinker==1.7.0
+    # via pelican
+docutils==0.20.1
+    # via pelican
+feedgenerator==2.1.0
+    # via pelican
+jinja2==3.1.2
+    # via pelican
+markdown==3.5.1
+    # via pelican
+markdown-it-py==3.0.0
+    # via rich
+markupsafe==2.1.3
+    # via jinja2
+mdurl==0.1.2
+    # via markdown-it-py
+pelican[markdown]==4.8.0
+    # via -r requirements.in
+pygments==2.16.1
+    # via
+    #   pelican
+    #   rich
+python-dateutil==2.8.2
+    # via pelican
+pytz==2023.3.post1
+    # via
+    #   feedgenerator
+    #   pelican
+rich==13.6.0
+    # via pelican
+six==1.16.0
+    # via python-dateutil
+unidecode==1.3.7
+    # via pelican

Diff for: requirements_dev.in

@@ -0,0 +1,2 @@
+-c requirements.txt
+pytest

Diff for: requirements_dev.txt

@@ -0,0 +1,14 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile requirements_dev.in
+#
+iniconfig==2.0.0
+    # via pytest
+packaging==23.2
+    # via pytest
+pluggy==1.3.0
+    # via pytest
+pytest==7.4.3
+    # via -r requirements_dev.in