From 21d4d3181eb475ace3d94a4e22937381ce82e62d Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sat, 12 Jul 2025 01:06:31 -0400 Subject: [PATCH 01/26] wip: generate RSS feed --- pyproject.toml | 3 ++- src/zona/config.py | 4 ++++ src/zona/feed.py | 1 + uv.lock | 52 ++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 59 insertions(+), 1 deletion(-) create mode 100644 src/zona/feed.py diff --git a/pyproject.toml b/pyproject.toml index aea7a42..fec9f67 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -9,6 +9,7 @@ authors = [ requires-python = ">=3.12" dependencies = [ "dacite>=1.9.2", + "feedgen>=1.0.0", "jinja2>=3.1.6", "l2m4m>=1.0.4", "markdown>=3.8.2", @@ -52,7 +53,7 @@ reportUnusedCallResult = false reportCallInDefaultInitializer = false enableTypeIgnoreComments = true reportIgnoreCommentWithoutRule = false -allowedUntypedLibraries = ["frontmatter", "pygments", "pymdownx", "l2m4m"] +allowedUntypedLibraries = ["frontmatter", "pygments", "pymdownx", "l2m4m", "feedgen"] [tool.ruff] line-length = 70 diff --git a/src/zona/config.py b/src/zona/config.py index 4bd7a42..8f4a0f2 100644 --- a/src/zona/config.py +++ b/src/zona/config.py @@ -64,6 +64,10 @@ IGNORELIST = [".marksman.toml"] @dataclass class ZonaConfig: base_url: str = "/" + link: str = "example.com" + title: str = "Zona Website" + description: str = "My zona website." + language: str = "en" # dictionary where key is name, value is url sitemap: SitemapConfig = field(default_factory=lambda: {"Home": "/"}) # list of globs relative to content that should be ignored diff --git a/src/zona/feed.py b/src/zona/feed.py new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/src/zona/feed.py @@ -0,0 +1 @@ + diff --git a/uv.lock b/uv.lock index 311053e..0699f3a 100644 --- a/uv.lock +++ b/uv.lock @@ -44,6 +44,16 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/94/35/386550fd60316d1e37eccdda609b074113298f23cef5bddb2049823fe666/dacite-1.9.2-py3-none-any.whl", hash = "sha256:053f7c3f5128ca2e9aceb66892b1a3c8936d02c686e707bee96e19deef4bc4a0", size = 16600, upload-time = "2025-02-05T09:27:24.345Z" }, ] +[[package]] +name = "feedgen" +version = "1.0.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "lxml" }, + { name = "python-dateutil" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/6b/59/be0a6f852b5dfbf19e6c8e962c8f41407697f9f52a7902250ed98683ae89/feedgen-1.0.0.tar.gz", hash = "sha256:d9bd51c3b5e956a2a52998c3708c4d2c729f2fcc311188e1e5d3b9726393546a", size = 258496, upload-time = "2023-12-25T18:04:08.421Z" } + [[package]] name = "iniconfig" version = "2.1.0" @@ -87,6 +97,46 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/1e/fd/aba08bb9e527168efad57985d7db9a853eb2384b1efa5ca5f3a3794c9cef/latex2mathml-3.78.0-py3-none-any.whl", hash = "sha256:1aeca3dc027b3006ad7b301b7f4a15ffbb4c1451e3dc8c3389e97b37b497e1d6", size = 73673, upload-time = "2025-05-03T16:51:51.991Z" }, ] +[[package]] +name = "lxml" +version = "6.0.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/c5/ed/60eb6fa2923602fba988d9ca7c5cdbd7cf25faa795162ed538b527a35411/lxml-6.0.0.tar.gz", hash = "sha256:032e65120339d44cdc3efc326c9f660f5f7205f3a535c1fdbf898b29ea01fb72", size = 4096938, upload-time = "2025-06-26T16:28:19.373Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/89/c3/d01d735c298d7e0ddcedf6f028bf556577e5ab4f4da45175ecd909c79378/lxml-6.0.0-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:78718d8454a6e928470d511bf8ac93f469283a45c354995f7d19e77292f26108", size = 8429515, upload-time = "2025-06-26T16:26:06.776Z" }, + { url = "https://files.pythonhosted.org/packages/06/37/0e3eae3043d366b73da55a86274a590bae76dc45aa004b7042e6f97803b1/lxml-6.0.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:84ef591495ffd3f9dcabffd6391db7bb70d7230b5c35ef5148354a134f56f2be", size = 4601387, upload-time = "2025-06-26T16:26:09.511Z" }, + { url = "https://files.pythonhosted.org/packages/a3/28/e1a9a881e6d6e29dda13d633885d13acb0058f65e95da67841c8dd02b4a8/lxml-6.0.0-cp312-cp312-manylinux2010_i686.manylinux2014_i686.manylinux_2_12_i686.manylinux_2_17_i686.whl", hash = "sha256:2930aa001a3776c3e2601cb8e0a15d21b8270528d89cc308be4843ade546b9ab", size = 5228928, upload-time = "2025-06-26T16:26:12.337Z" }, + { url = "https://files.pythonhosted.org/packages/9a/55/2cb24ea48aa30c99f805921c1c7860c1f45c0e811e44ee4e6a155668de06/lxml-6.0.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:219e0431ea8006e15005767f0351e3f7f9143e793e58519dc97fe9e07fae5563", size = 4952289, upload-time = "2025-06-28T18:47:25.602Z" }, + { url = "https://files.pythonhosted.org/packages/31/c0/b25d9528df296b9a3306ba21ff982fc5b698c45ab78b94d18c2d6ae71fd9/lxml-6.0.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:bd5913b4972681ffc9718bc2d4c53cde39ef81415e1671ff93e9aa30b46595e7", size = 5111310, upload-time = "2025-06-28T18:47:28.136Z" }, + { url = "https://files.pythonhosted.org/packages/e9/af/681a8b3e4f668bea6e6514cbcb297beb6de2b641e70f09d3d78655f4f44c/lxml-6.0.0-cp312-cp312-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:390240baeb9f415a82eefc2e13285016f9c8b5ad71ec80574ae8fa9605093cd7", size = 5025457, upload-time = "2025-06-26T16:26:15.068Z" }, + { url = "https://files.pythonhosted.org/packages/99/b6/3a7971aa05b7be7dfebc7ab57262ec527775c2c3c5b2f43675cac0458cad/lxml-6.0.0-cp312-cp312-manylinux_2_27_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:d6e200909a119626744dd81bae409fc44134389e03fbf1d68ed2a55a2fb10991", size = 5657016, upload-time = "2025-07-03T19:19:06.008Z" }, + { url = "https://files.pythonhosted.org/packages/69/f8/693b1a10a891197143c0673fcce5b75fc69132afa81a36e4568c12c8faba/lxml-6.0.0-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:ca50bd612438258a91b5b3788c6621c1f05c8c478e7951899f492be42defc0da", size = 5257565, upload-time = "2025-06-26T16:26:17.906Z" }, + { url = "https://files.pythonhosted.org/packages/a8/96/e08ff98f2c6426c98c8964513c5dab8d6eb81dadcd0af6f0c538ada78d33/lxml-6.0.0-cp312-cp312-manylinux_2_31_armv7l.whl", hash = "sha256:c24b8efd9c0f62bad0439283c2c795ef916c5a6b75f03c17799775c7ae3c0c9e", size = 4713390, upload-time = "2025-06-26T16:26:20.292Z" }, + { url = "https://files.pythonhosted.org/packages/a8/83/6184aba6cc94d7413959f6f8f54807dc318fdcd4985c347fe3ea6937f772/lxml-6.0.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:afd27d8629ae94c5d863e32ab0e1d5590371d296b87dae0a751fb22bf3685741", size = 5066103, upload-time = "2025-06-26T16:26:22.765Z" }, + { url = "https://files.pythonhosted.org/packages/ee/01/8bf1f4035852d0ff2e36a4d9aacdbcc57e93a6cd35a54e05fa984cdf73ab/lxml-6.0.0-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:54c4855eabd9fc29707d30141be99e5cd1102e7d2258d2892314cf4c110726c3", size = 4791428, upload-time = "2025-06-26T16:26:26.461Z" }, + { url = "https://files.pythonhosted.org/packages/29/31/c0267d03b16954a85ed6b065116b621d37f559553d9339c7dcc4943a76f1/lxml-6.0.0-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:c907516d49f77f6cd8ead1322198bdfd902003c3c330c77a1c5f3cc32a0e4d16", size = 5678523, upload-time = "2025-07-03T19:19:09.837Z" }, + { url = "https://files.pythonhosted.org/packages/5c/f7/5495829a864bc5f8b0798d2b52a807c89966523140f3d6fa3a58ab6720ea/lxml-6.0.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:36531f81c8214e293097cd2b7873f178997dae33d3667caaae8bdfb9666b76c0", size = 5281290, upload-time = "2025-06-26T16:26:29.406Z" }, + { url = "https://files.pythonhosted.org/packages/79/56/6b8edb79d9ed294ccc4e881f4db1023af56ba451909b9ce79f2a2cd7c532/lxml-6.0.0-cp312-cp312-win32.whl", hash = "sha256:690b20e3388a7ec98e899fd54c924e50ba6693874aa65ef9cb53de7f7de9d64a", size = 3613495, upload-time = "2025-06-26T16:26:31.588Z" }, + { url = "https://files.pythonhosted.org/packages/0b/1e/cc32034b40ad6af80b6fd9b66301fc0f180f300002e5c3eb5a6110a93317/lxml-6.0.0-cp312-cp312-win_amd64.whl", hash = "sha256:310b719b695b3dd442cdfbbe64936b2f2e231bb91d998e99e6f0daf991a3eba3", size = 4014711, upload-time = "2025-06-26T16:26:33.723Z" }, + { url = "https://files.pythonhosted.org/packages/55/10/dc8e5290ae4c94bdc1a4c55865be7e1f31dfd857a88b21cbba68b5fea61b/lxml-6.0.0-cp312-cp312-win_arm64.whl", hash = "sha256:8cb26f51c82d77483cdcd2b4a53cda55bbee29b3c2f3ddeb47182a2a9064e4eb", size = 3674431, upload-time = "2025-06-26T16:26:35.959Z" }, + { url = "https://files.pythonhosted.org/packages/79/21/6e7c060822a3c954ff085e5e1b94b4a25757c06529eac91e550f3f5cd8b8/lxml-6.0.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:6da7cd4f405fd7db56e51e96bff0865b9853ae70df0e6720624049da76bde2da", size = 8414372, upload-time = "2025-06-26T16:26:39.079Z" }, + { url = "https://files.pythonhosted.org/packages/a4/f6/051b1607a459db670fc3a244fa4f06f101a8adf86cda263d1a56b3a4f9d5/lxml-6.0.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:b34339898bb556a2351a1830f88f751679f343eabf9cf05841c95b165152c9e7", size = 4593940, upload-time = "2025-06-26T16:26:41.891Z" }, + { url = "https://files.pythonhosted.org/packages/8e/74/dd595d92a40bda3c687d70d4487b2c7eff93fd63b568acd64fedd2ba00fe/lxml-6.0.0-cp313-cp313-manylinux2010_i686.manylinux2014_i686.manylinux_2_12_i686.manylinux_2_17_i686.whl", hash = "sha256:51a5e4c61a4541bd1cd3ba74766d0c9b6c12d6a1a4964ef60026832aac8e79b3", size = 5214329, upload-time = "2025-06-26T16:26:44.669Z" }, + { url = "https://files.pythonhosted.org/packages/52/46/3572761efc1bd45fcafb44a63b3b0feeb5b3f0066886821e94b0254f9253/lxml-6.0.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:d18a25b19ca7307045581b18b3ec9ead2b1db5ccd8719c291f0cd0a5cec6cb81", size = 4947559, upload-time = "2025-06-28T18:47:31.091Z" }, + { url = "https://files.pythonhosted.org/packages/94/8a/5e40de920e67c4f2eef9151097deb9b52d86c95762d8ee238134aff2125d/lxml-6.0.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:d4f0c66df4386b75d2ab1e20a489f30dc7fd9a06a896d64980541506086be1f1", size = 5102143, upload-time = "2025-06-28T18:47:33.612Z" }, + { url = "https://files.pythonhosted.org/packages/7c/4b/20555bdd75d57945bdabfbc45fdb1a36a1a0ff9eae4653e951b2b79c9209/lxml-6.0.0-cp313-cp313-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:9f4b481b6cc3a897adb4279216695150bbe7a44c03daba3c894f49d2037e0a24", size = 5021931, upload-time = "2025-06-26T16:26:47.503Z" }, + { url = "https://files.pythonhosted.org/packages/b6/6e/cf03b412f3763d4ca23b25e70c96a74cfece64cec3addf1c4ec639586b13/lxml-6.0.0-cp313-cp313-manylinux_2_27_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:8a78d6c9168f5bcb20971bf3329c2b83078611fbe1f807baadc64afc70523b3a", size = 5645469, upload-time = "2025-07-03T19:19:13.32Z" }, + { url = "https://files.pythonhosted.org/packages/d4/dd/39c8507c16db6031f8c1ddf70ed95dbb0a6d466a40002a3522c128aba472/lxml-6.0.0-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:2ae06fbab4f1bb7db4f7c8ca9897dc8db4447d1a2b9bee78474ad403437bcc29", size = 5247467, upload-time = "2025-06-26T16:26:49.998Z" }, + { url = "https://files.pythonhosted.org/packages/4d/56/732d49def0631ad633844cfb2664563c830173a98d5efd9b172e89a4800d/lxml-6.0.0-cp313-cp313-manylinux_2_31_armv7l.whl", hash = "sha256:1fa377b827ca2023244a06554c6e7dc6828a10aaf74ca41965c5d8a4925aebb4", size = 4720601, upload-time = "2025-06-26T16:26:52.564Z" }, + { url = "https://files.pythonhosted.org/packages/8f/7f/6b956fab95fa73462bca25d1ea7fc8274ddf68fb8e60b78d56c03b65278e/lxml-6.0.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:1676b56d48048a62ef77a250428d1f31f610763636e0784ba67a9740823988ca", size = 5060227, upload-time = "2025-06-26T16:26:55.054Z" }, + { url = "https://files.pythonhosted.org/packages/97/06/e851ac2924447e8b15a294855caf3d543424364a143c001014d22c8ca94c/lxml-6.0.0-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:0e32698462aacc5c1cf6bdfebc9c781821b7e74c79f13e5ffc8bfe27c42b1abf", size = 4790637, upload-time = "2025-06-26T16:26:57.384Z" }, + { url = "https://files.pythonhosted.org/packages/06/d4/fd216f3cd6625022c25b336c7570d11f4a43adbaf0a56106d3d496f727a7/lxml-6.0.0-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:4d6036c3a296707357efb375cfc24bb64cd955b9ec731abf11ebb1e40063949f", size = 5662049, upload-time = "2025-07-03T19:19:16.409Z" }, + { url = "https://files.pythonhosted.org/packages/52/03/0e764ce00b95e008d76b99d432f1807f3574fb2945b496a17807a1645dbd/lxml-6.0.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:7488a43033c958637b1a08cddc9188eb06d3ad36582cebc7d4815980b47e27ef", size = 5272430, upload-time = "2025-06-26T16:27:00.031Z" }, + { url = "https://files.pythonhosted.org/packages/5f/01/d48cc141bc47bc1644d20fe97bbd5e8afb30415ec94f146f2f76d0d9d098/lxml-6.0.0-cp313-cp313-win32.whl", hash = "sha256:5fcd7d3b1d8ecb91445bd71b9c88bdbeae528fefee4f379895becfc72298d181", size = 3612896, upload-time = "2025-06-26T16:27:04.251Z" }, + { url = "https://files.pythonhosted.org/packages/f4/87/6456b9541d186ee7d4cb53bf1b9a0d7f3b1068532676940fdd594ac90865/lxml-6.0.0-cp313-cp313-win_amd64.whl", hash = "sha256:2f34687222b78fff795feeb799a7d44eca2477c3d9d3a46ce17d51a4f383e32e", size = 4013132, upload-time = "2025-06-26T16:27:06.415Z" }, + { url = "https://files.pythonhosted.org/packages/b7/42/85b3aa8f06ca0d24962f8100f001828e1f1f1a38c954c16e71154ed7d53a/lxml-6.0.0-cp313-cp313-win_arm64.whl", hash = "sha256:21db1ec5525780fd07251636eb5f7acb84003e9382c72c18c542a87c416ade03", size = 3672642, upload-time = "2025-06-26T16:27:09.888Z" }, +] + [[package]] name = "markdown" version = "3.8.2" @@ -463,6 +513,7 @@ version = "0.1.0" source = { editable = "." } dependencies = [ { name = "dacite" }, + { name = "feedgen" }, { name = "jinja2" }, { name = "l2m4m" }, { name = "markdown" }, @@ -489,6 +540,7 @@ dev = [ [package.metadata] requires-dist = [ { name = "dacite", specifier = ">=1.9.2" }, + { name = "feedgen", specifier = ">=1.0.0" }, { name = "jinja2", specifier = ">=3.1.6" }, { name = "l2m4m", specifier = ">=1.0.4" }, { name = "markdown", specifier = ">=3.8.2" }, From dacea2756af75d1151788cc0c1b2eefbead3c01f Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sun, 13 Jul 2025 03:13:58 -0400 Subject: [PATCH 02/26] fix: live preview rebuilds no longer crash the server When cleaning the previous build, we deleted the entire directory, which caused problems. Now, we only clean the output dir's children, but leave the dir itself intact. --- src/zona/builder.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/zona/builder.py b/src/zona/builder.py index de16bf5..12b5458 100644 --- a/src/zona/builder.py +++ b/src/zona/builder.py @@ -145,7 +145,13 @@ class ZonaBuilder: and self.layout.output.is_dir() ): logger.debug("Removing stale output...") - shutil.rmtree(self.layout.output) + # only remove output dir's children + # to avoid breaking live preview + for child in self.layout.output.iterdir(): + if child.is_file() or child.is_symlink(): + child.unlink() + elif child.is_dir(): + shutil.rmtree(child) logger.debug("Discovering...") self._discover() logger.debug("Building...") From 585a987c3fab06e83d3ff3dbac9e02cbcbc3adc0 Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sun, 13 Jul 2025 16:04:17 -0400 Subject: [PATCH 03/26] updated default css --- src/zona/data/content/static/style.css | 338 ++++++++++++++----------- 1 file changed, 186 insertions(+), 152 deletions(-) diff --git a/src/zona/data/content/static/style.css b/src/zona/data/content/static/style.css index 641f9cf..284a5ce 100644 --- a/src/zona/data/content/static/style.css +++ b/src/zona/data/content/static/style.css @@ -1,20 +1,20 @@ :root { - --main-text-color: #b4b4b4; - --main-bg-color: #121212; - --main-link-color: #df6464; - --main-heading-color: #df6464; - --main-bullet-color: #d87c4a; - --main-transparent: rgba(255, 255, 255, 0.15); - --main-small-text-color: rgba(255, 255, 255, 0.45); + --main-text-color: #b4b4b4; + --main-bg-color: #121212; + --main-link-color: #df6464; + --main-heading-color: #df6464; + --main-bullet-color: #d87c4a; + --main-transparent: rgba(255, 255, 255, 0.15); + --main-small-text-color: rgba(255, 255, 255, 0.45); } body { - line-height: 1.6; - font-size: 18px; - font-family: sans-serif; - background: var(--main-bg-color); - color: var(--main-text-color); - padding-left: calc(100vw - 100%); + line-height: 1.6; + font-size: 18px; + font-family: sans-serif; + background: var(--main-bg-color); + color: var(--main-text-color); + padding-left: calc(100vw - 100%); } .toclink { @@ -63,278 +63,312 @@ h3, h4, h5, h6 { - color: var(--main-heading-color); + color: var(--main-heading-color); } h1 { - margin-block-start: 0.67rem; - margin-block-end: 0.67rem; - font-size: 2rem; - font-weight: bold; + margin-block-start: 0.67rem; + margin-block-end: 0.67rem; + font-size: 2rem; + font-weight: bold; } article h1:first-of-type { - margin-block-start: 1.67rem; + margin-block-start: 1.67rem; } h2 { - margin-block-start: 0.83rem; - margin-block-end: 0.83rem; - font-size: 1.5rem; - font-weight: bold; + margin-block-start: 0.83rem; + margin-block-end: 0.83rem; + font-size: 1.5rem; + font-weight: bold; } h3 { - margin-block-start: 1rem; - margin-block-end: 1rem; - font-size: 1.17em; - font-weight: bold; + margin-block-start: 1rem; + margin-block-end: 1rem; + font-size: 1.17em; + font-weight: bold; } h4 { - margin-block-start: 1.33rem; - margin-block-end: 1.33rem; - font-size: 1rem; - font-weight: bold; + margin-block-start: 1.33rem; + margin-block-end: 1.33rem; + font-size: 1rem; + font-weight: bold; } -article h1+h4:first-of-type { - margin-block-start: 0rem; +article h1 + h4:first-of-type { + margin-block-start: 0rem; } h5 { - margin-block-start: 1.67rem; - margin-block-end: 1.67rem; - font-size: 0.83rem; - font-weight: bold; + margin-block-start: 1.67rem; + margin-block-end: 1.67rem; + font-size: 0.83rem; + font-weight: bold; } h6 { - margin-block-start: 2.33rem; - margin-block-end: 2.33rem; - font-size: 0.67rem; - font-weight: bold; + margin-block-start: 2.33rem; + margin-block-end: 2.33rem; + font-size: 0.67rem; + font-weight: bold; } ul { - list-style-type: disc; - /* or any other list style */ + list-style-type: disc; + /* or any other list style */ } li::marker { - color: var(--main-bullet-color); - /* Change this to your desired color */ + color: var(--main-bullet-color); + /* Change this to your desired color */ } a { - color: var(--main-link-color); + color: var(--main-link-color); + text-decoration: underline; } a:hover { - background: var(--main-transparent); + background: var(--main-transparent); } max-width: 100%; overflow: hidden; img { - display: block; - margin-left: auto; - margin-right: auto; - width: auto; - height: auto; + display: block; + margin-left: auto; + margin-right: auto; + width: auto; + height: auto; } blockquote { - color: var(--main-small-text-color); - border-left: 3px solid var(--main-transparent); - padding: 0 1rem; - margin-left: 0; - margin-right: 0; + color: var(--main-small-text-color); + border-left: 3px solid var(--main-transparent); + padding: 0 1rem; + margin-left: 0; + margin-right: 0; } hr { - border: none; - height: 1px; - background: var(--main-small-text-color); + border: none; + height: 1px; + background: var(--main-small-text-color); } code { - background: var(--main-transparent); - border-radius: 0.1875rem; - /* padding: .0625rem .1875rem; */ - /* margin: 0 .1875rem; */ + background: var(--main-transparent); + border-radius: 0.1875rem; + /* padding: .0625rem .1875rem; */ + /* margin: 0 .1875rem; */ } code, pre { - white-space: pre; - word-wrap: break-word; - overflow-wrap: break-word; - font-family: monospace; - font-size: 0.95em; + white-space: pre; + word-wrap: break-word; + overflow-wrap: break-word; + font-family: + ui-monospace, + SFMono-Regular, + SF Mono, + Menlo, + Consolas, + Liberation Mono, + monospace; + font-size: 0.95em; } pre { - background-color: #151515; - color: #d5d5d5; - padding: 1em; - border-radius: 5px; - line-height: 1.5; - overflow-x: auto; + background-color: #151515; + color: #d5d5d5; + padding: 1em; + border-radius: 5px; + line-height: 1.5; + overflow-x: auto; } /* Inline code styling */ :not(pre) > code { - padding: 0.2em 0.4em; - border-radius: 3px; - background-color: #1d1d1d; - color: #d5d5d5; - font-size: 0.85em; + padding: 0.2em 0.4em; + font-size: 0.85em; + line-height: 1; + background-color: #1d1d1d; + border-radius: 6px; + vertical-align: middle; + font-family: + ui-monospace, + SFMono-Regular, + SF Mono, + Menlo, + Consolas, + Liberation Mono, + monospace; } /* Block code styling (inherits from pre) */ pre code { - padding: 0; - border-radius: 0; - background: none; + padding: 0; + border-radius: 0; + background: none; } small { - font-size: 0.95rem; - color: var(--main-small-text-color); + font-size: 0.95rem; + color: var(--main-small-text-color); } small a { - color: inherit; - /* Inherit the color of the surrounding text */ - text-decoration: underline; - /* Optional: Keep the underline to indicate a link */ + color: inherit; + /* Inherit the color of the surrounding text */ + text-decoration: underline; + /* Optional: Keep the underline to indicate a link */ } .title-container { - display: flex; - justify-content: center; - align-items: center; - text-align: center; + display: flex; + justify-content: center; + align-items: center; + text-align: center; } .title-container h1 { - margin: 0; + margin: 0; } .image-container { - text-align: center; - margin: 20px 0; - max-width: 100%; - overflow: hidden; - /* Optional: add some spacing around the image container */ + text-align: center; + margin: 20px 0; + max-width: 100%; + overflow: hidden; + /* Optional: add some spacing around the image container */ } .image-container img { - max-width: 100%; - width: auto; - max-height: 100%; - height: auto; + max-width: 100%; + width: auto; + max-height: 100%; + height: auto; } .fixed .image-container img { - max-width: 308px; - max-height: 308px; + max-width: 308px; + max-height: 308px; } .image-container small { - display: block; - /* Ensure the caption is on a new line */ - margin-top: 5px; - /* Optional: adjust spacing between image and caption */ + display: block; + /* Ensure the caption is on a new line */ + margin-top: 5px; + /* Optional: adjust spacing between image and caption */ } .image-container small a { - color: inherit; - /* Ensure the link color matches the small text */ - text-decoration: underline; - /* Optional: underline to indicate a link */ + color: inherit; + /* Ensure the link color matches the small text */ + text-decoration: underline; + /* Optional: underline to indicate a link */ } #header ul { - list-style-type: none; - padding-left: 0; + list-style-type: none; + padding-left: 0; } #header li { - display: inline; - font-size: 1.2rem; - margin-right: 1.2rem; + display: inline; + font-size: 1.2rem; + margin-right: 1.2rem; } #container { - margin: 2.5rem auto; - width: 90%; - max-width: 60ch; + margin: 2.5rem auto; + width: 90%; + max-width: 60ch; } #postlistdiv ul { - list-style-type: none; - padding-left: 0; + list-style-type: none; + padding-left: 0; } .moreposts { - font-size: 0.95rem; - padding-left: 0.5rem; + font-size: 0.95rem; + padding-left: 0.5rem; } #nextprev { - text-align: center; - margin-top: 1.4rem; - font-size: 0.95rem; + text-align: center; + margin-top: 1.4rem; + font-size: 0.95rem; } #footer { - color: var(--main-small-text-color); + color: var(--main-small-text-color); } table { - border-collapse: collapse; - margin: 1.5rem auto; - width: 100%; - max-width: 100%; - font-size: 0.85rem; - text-align: left; /* Use center if you prefer */ + border-collapse: collapse; + margin: 1.5rem auto; + width: 100%; + max-width: 100%; + font-size: 0.85rem; + text-align: left; /* Use center if you prefer */ } th, td { - border: 1px solid var(--main-transparent); - /*border: 1px solid var(--main-bullet-color);*/ - padding: 0.4rem 0.8rem; - vertical-align: middle; + border: 1px solid var(--main-transparent); + /*border: 1px solid var(--main-bullet-color);*/ + padding: 0.4rem 0.8rem; + vertical-align: middle; } thead th { - font-weight: bold; - background-color: rgba(255, 255, 255, 0.05); - color: var(--main-text-color); + font-weight: bold; + background-color: rgba(255, 255, 255, 0.05); + color: var(--main-text-color); } tbody tr:nth-child(even) { - background-color: rgba(255, 255, 255, 0.02); + background-color: rgba(255, 255, 255, 0.02); } tbody tr:hover { - background-color: rgba(255, 255, 255, 0.05); + background-color: rgba(255, 255, 255, 0.05); } table code { - font-family: monospace; - font-size: 0.85em; - background: #1d1d1d; - padding: 0.1em 0.25em; - border-radius: 3px; + font-family: + ui-monospace, + SFMono-Regular, + SF Mono, + Menlo, + Consolas, + Liberation Mono, + monospace; + font-size: 0.85em; + background: #1d1d1d; + padding: 0.1em 0.25em; + border-radius: 3px; } caption { - margin-top: 0.5rem; - font-size: 0.8rem; - color: var(--main-small-text-color); + margin-top: 0.5rem; + font-size: 0.8rem; + color: var(--main-small-text-color); } +a > code { + text-decoration: none; + color: inherit; +} +a:has(> code) { + text-decoration: none; +} +a:hover > code { + background-color: var(--main-transparent); +} From 1c64d1f431e4ce0b37ed697aa23fc04233087ff8 Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sun, 13 Jul 2025 16:54:04 -0400 Subject: [PATCH 04/26] make injection script template a data file --- src/zona/data/server/inject.js | 6 ++++++ src/zona/server.py | 21 ++++++++++--------- src/zona/util.py | 37 +++++++++++++++++++++++++++++----- 3 files changed, 49 insertions(+), 15 deletions(-) create mode 100644 src/zona/data/server/inject.js diff --git a/src/zona/data/server/inject.js b/src/zona/data/server/inject.js new file mode 100644 index 0000000..550830f --- /dev/null +++ b/src/zona/data/server/inject.js @@ -0,0 +1,6 @@ +const ws = new WebSocket("__SOCKET_ADDRESS_"); +ws.onmessage = event => { + if (event.data === "reload") { + location.reload(); + } +}; diff --git a/src/zona/server.py b/src/zona/server.py index fa0c033..b2e0a64 100644 --- a/src/zona/server.py +++ b/src/zona/server.py @@ -13,6 +13,7 @@ from rich import print from watchdog.events import FileSystemEvent, FileSystemEventHandler from watchdog.observers import Observer +from zona import util from zona.builder import ZonaBuilder from zona.log import get_logger from zona.websockets import WebSocketServer @@ -22,16 +23,16 @@ logger = get_logger() def make_reload_script(host: str, port: int) -> str: """Generates the JavaScript that must be injected into HTML pages for the live reloading to work.""" - return f""" - -""" + js = util.get_resource("server/inject.js").contents + js = util.minify_js(js) + address = f"ws://{host}:{port}" + for placeholder, value in (("__SOCKET_ADDRESS_", address),): + if placeholder not in js: + raise ValueError( + f"{placeholder} missing from reload script template!" + ) + js = js.replace(placeholder, value) + return f"" def make_handler_class(script: str): diff --git a/src/zona/util.py b/src/zona/util.py index 7e80500..2d5c514 100644 --- a/src/zona/util.py +++ b/src/zona/util.py @@ -1,4 +1,5 @@ import fnmatch +import re import string from importlib import resources from importlib.resources.abc import Traversable @@ -12,6 +13,15 @@ class ZonaResource(NamedTuple): contents: str +def get_resource(path: str) -> ZonaResource: + """Load the packaged resource in data/path""" + file = resources.files("zona").joinpath("data", path) + if file.is_file(): + return ZonaResource(name=path, contents=file.read_text()) + else: + raise FileNotFoundError(f"{path} is not a valid Zona resource!") + + def get_resources(subdir: str) -> list[ZonaResource]: """Load the packaged resources in data/subdir""" out: list[ZonaResource] = [] @@ -65,11 +75,28 @@ def normalize_url(url: str) -> str: return url -def should_ignore( - path: Path, patterns: list[str], base: Path -) -> bool: +def should_ignore(path: Path, patterns: list[str], base: Path) -> bool: rel_path = path.relative_to(base) return any( - fnmatch.fnmatch(str(rel_path), pattern) - for pattern in patterns + fnmatch.fnmatch(str(rel_path), pattern) for pattern in patterns ) + + +MINIFY_JS_PATTERN = re.compile( + r""" + //.*?$ | + /\*.*?\*/ | + \s+ + """, + re.MULTILINE | re.DOTALL | re.VERBOSE, +) + + +def minify_js(js: str) -> str: + """Naively minifies JavaScript by stripping comments and whitespace.""" + return MINIFY_JS_PATTERN.sub( + # replace whitespace with single space, + # strip comments + lambda m: " " if m.group(0).isspace() else "", + js, + ).strip() From fe0f3388034e939c125e30d8e808ccda7b9dcb4a Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sun, 13 Jul 2025 17:20:59 -0400 Subject: [PATCH 05/26] added auto-scrolling for preview --- src/zona/data/server/inject.js | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/src/zona/data/server/inject.js b/src/zona/data/server/inject.js index 550830f..d199c03 100644 --- a/src/zona/data/server/inject.js +++ b/src/zona/data/server/inject.js @@ -1,6 +1,24 @@ -const ws = new WebSocket("__SOCKET_ADDRESS_"); -ws.onmessage = event => { +(() => { + // if user at the bottom before reload, scroll to new bottom + if (localStorage.getItem("wasAtBottom") === "1") { + localStorage.removeItem("wasAtBottom"); + window.addEventListener("load", () => { + requestAnimationFrame(() => { + window.scrollTo(0, document.body.scrollHeight); + }); + }); + } + + const ws = new WebSocket("__SOCKET_ADDRESS_"); + ws.onmessage = event => { if (event.data === "reload") { - location.reload(); + // store flag if user currently at bottom + const nearBottom = window.innerHeight + window.scrollY + >= document.body.scrollHeight - 100; + if (nearBottom) { + localStorage.setItem("wasAtBottom", "1"); + } + location.reload(); } -}; + }; +})(); From 10d1772a2d7a14c977e8359e3df25a2a40948daa Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sun, 13 Jul 2025 17:31:25 -0400 Subject: [PATCH 06/26] added config option for preview scroll tolerance --- README.md | 328 +++++++++++++++++---------------- src/zona/cli.py | 19 +- src/zona/config.py | 12 ++ src/zona/data/server/inject.js | 5 +- src/zona/server.py | 28 ++- 5 files changed, 217 insertions(+), 175 deletions(-) diff --git a/README.md b/README.md index 9ae4ef4..df3c866 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,22 @@

zona

-[zona](https://sr.ht/~ficd/zona) is an _opinionated_ static site generator -written in Python. From a structured directory of Markdown content, zona -builds a simple static website. It's designed to get out of your way and -let you focus on writing. +[zona](https://git.ficd.sh/ficd/zona) is an _opinionated_ static site generator +written in Python. From a structured directory of Markdown content, zona builds +a simple static website. It's designed to get out of your way and let you focus +on writing. -**What do I mean by opinionated?** I built zona primarily for myself. I've -tried making it flexible by exposing as many variables as possible to the -template engine. However, if you're looking for something stable, -complete, and fully configurable, zona may not be for you. If you want a -minimal Markdown blog and are comfortable with modifying `jinja2` -templates and CSS, then you're in luck. +**What do I mean by opinionated?** I built zona primarily for myself. I've tried +making it flexible by exposing as many variables as possible to the template +engine. However, if you're looking for something stable, complete, and fully +configurable, zona may not be for you. If you want a minimal Markdown blog and +are comfortable with modifying `jinja2` templates and CSS, then you're in luck. -**Note:** This project is in early development, there are no versioned -releases yet, and breaking changes are likely. Versioned releases will be -made and zona will be published to PyPI once it's stable. zona was -previously implemented in Go; I decided to rewrite the project in Python. -If you're interested in seeing the previous codebase (which is feature -incomplete), visit the [~ficd/zona-go](https://git.sr.ht/~ficd/zona-go) -repository. +**Note:** This project is in early development, there are no versioned releases +yet, and breaking changes are likely. Versioned releases will be made and zona +will be published to PyPI once it's stable. zona was previously implemented in +Go; I decided to rewrite the project in Python. If you're interested in seeing +the previous codebase (which is feature incomplete), visit the +[zona-go](https://git.ficd.sh/ficd/zona-go) repository. For an example of a website built with zona, please see [ficd.sh](https://ficd.sh). @@ -31,6 +29,7 @@ For an example of a website built with zona, please see - [Getting Started](#getting-started) - [Building](#building) - [Live Preview](#live-preview) + - [Live Reload](#live-reload) - [How It Works](#how-it-works) - [Site Layout](#site-layout) - [Templates](#templates) @@ -60,15 +59,15 @@ For an example of a website built with zona, please see - Easily configurable sitemap header. - Site footer written in Markdown. - Smart site layout discovery. - - Blog posts are automatically discovered and rendered accordingly (can - be overridden in frontmatter). + - Blog posts are automatically discovered and rendered accordingly (can be + overridden in frontmatter). - Extended Markdown renderer: - Smart internal link resolution. - Syntax highlighting. - Includes Kakoune syntax and [Ashen] highlighting. - [Image labels](#image-labels). - - Many `python-markdown` extensions enabled, including footnotes, - tables, abbreviations, etc. + - Many `python-markdown` extensions enabled, including footnotes, tables, + abbreviations, etc. - LaTeX support. ## Installation @@ -77,7 +76,7 @@ zona is not yet packaged on PyPI. You may use `uv` to install it from this repository: ```sh -uv tool install 'git+https://git.sr.ht/~ficd/zona' +uv tool install 'git+https://git.ficd.sh/ficd/zona' ``` ## Usage @@ -87,71 +86,78 @@ available options and arguments._ ### Getting Started -To set up a new website, create a new directory and run `zona init` inside -of it. This creates the required directory structure and writes the -default configuration file. The default templates and default stylesheet -are also written. +To set up a new website, create a new directory and run `zona init` inside of +it. This creates the required directory structure and writes the default +configuration file. The default templates and default stylesheet are also +written. ### Building -To build the website, run `zona build`. The project root is discovered -according to the location of `config.yml`. By default, the output -directory is called `public`, and saved inside the root directory. +To build the website, run `zona build`. The project root is discovered according +to the location of `config.yml`. By default, the output directory is called +`public`, and saved inside the root directory. If you don't want discovery, you can specify the project root as the first argument to `zona build`. You may specify a path for the output using the -`--output/-o` flag. The `--draft/-d` flag includes draft posts in the -output. +`--output/-o` flag. The `--draft/-d` flag includes draft posts in the output. -_Note: the previous build is _not_ cleaned before the new site is built. -If you've deleted some pages, you may need to remove the output directory -before rebuilding._ +_Note: the previous build is _not_ cleaned before the new site is built. If +you've deleted some pages, you may need to remove the output directory before +rebuilding._ ### Live Preview -To make the writing process as frictionless as possible, zona ships with a -live preview server. It spins up an HTTP server, meaning that internal -links work properly (this is not the case if you simply open the `.html` -files in your browser.) +To make the writing process as frictionless as possible, zona ships with a live +preview server. It spins up an HTTP server, meaning that internal links work +properly (this is not the case if you simply open the `.html` files in your +browser.) -Additionally, the server watches for changes to all source files, and -rebuilds the website when they're modified. _Note: the entire website is -rebuilt — this ensures that links are properly resolved._ +Additionally, the server watches for changes to all source files, and rebuilds +the website when they're modified. _Note: the entire website is rebuilt — this +ensures that links are properly resolved._ -Optionally, live reloading of the browser is also provided. With this -feature (enabled by default), your browser will automatically refresh open -pages whenever the site is rebuilt. The live reloading requires JavaScript -support from the browser — this is why the feature is optional. +Drafts are enabled by default in live preview. Use `--final/-f` to disable them. +By default, the build outputs to a temporary directory. Use `-o/--output` to +override this. -To start a preview server, use `zona serve`. You can specify the root -directory as its first argument. Use the `--host` to specify a host name -(`localhost` by default) and `--port/-p` to specify a port (default: -`8000`). The `--no-live-reload/-n` disables the live browser reloading -(_automatic site rebuilds are not disabled_). +**Note**: if the live preview isn't working as expected, try restarting the +server. If you change the configuration or any templates, the server must also +be restarted. The live preview uses the same function as `zona build` +internally; this means that the output is also written to disk. -Drafts are enabled by default in live preview. Use `--final/-f` to disable -them. By default, the build outputs to a temporary directory. Use -`-o/--output` to override this. +#### Live Reload -**Note**: if the live preview isn't working as expected, try restarting -the server. If you change the configuration or any templates, the server -must also be restarted. The live preview uses the same function as -`zona build` internally; this means that the output is also written to -disk. +Optionally, live reloading of the browser is also provided. With this feature +(enabled by default), your browser will automatically refresh open pages +whenever the site is rebuilt. The live reloading requires JavaScript support +from the browser — this is why the feature is optional. + +To start a preview server, use `zona serve`. You can specify the root directory +as its first argument. Use the `--host` to specify a host name (`localhost` by +default) and `--port/-p` to specify a port (default: `8000`). + +The `--live-reload/--no-live-reload` option overrides the value set in the +[config](#configuration) (`true` by default). _Automatic site rebuilds are not +affected_. + +If you are scrolled to the bottom of the page in the browser, and you extend the +height of the page by adding new content, you will automatically be scrolled to +the _new_ bottom after reloading. You may tune the tolerance threshold in the +[configuration](#configuration). #### How It Works -The basic idea is this: after a rebuild, the server needs to notify your -browser to refresh the open pages. We implement this using a small amount -of JavaScript. The server injects a tiny script into any HTML page it -serves; which causes your browser to open a WebSocket connection with the -server. When the site is rebuilt, the server notifies your browser via the -WebSocket, which reloads the page. +The basic idea is this: after a rebuild, the server needs to notify your browser +to refresh the open pages. We implement this using a small amount of JavaScript. +The server injects a tiny script into any HTML page it serves; which causes your +browser to open a WebSocket connection with the server. When the site is +rebuilt, the server notifies your browser via the WebSocket, which reloads the +page. Unfortunately, there is no way to implement this feature without using -JavaScript. **JavaScript is _only_ used for the live preview feature. The -script is injected by the server, and never written to the HTML files in -the output directory.** +JavaScript. **JavaScript is _only_ used for the live preview feature. The script +is injected by the server, and never written to the HTML files in the output +directory.** ### Site Layout @@ -164,32 +170,30 @@ templates/ public/ ``` -The **root** of the zona **project** _must_ contain the configuration -file, `config.yml`, and a directory called `content`. A directory called -`templates` is optional, and prioritized if it exists. `public` is the -built site output — it's recommended to add this path to your -`.gitignore`. +The **root** of the zona **project** _must_ contain the configuration file, +`config.yml`, and a directory called `content`. A directory called `templates` +is optional, and prioritized if it exists. `public` is the built site output — +it's recommended to add this path to your `.gitignore`. The `content` directory is the **root of the website**. Think of it as the -**content root**. For example, suppose your website is hosted at -`example.com`. `content/blog/index.md` corresponds to `example.com/blog`, +**content root**. For example, suppose your website is hosted at `example.com`. +`content/blog/index.md` corresponds to `example.com/blog`, `content/blog/my-post.md` becomes `example.com/blog/my-post`, etc. - Internal links are resolved **relative to the `content` directory.** - Templates are resolved relative to the `template` directory. Markdown files inside a certain directory (`content/blog` by default) are -automatically treated as _blog posts_. This means they are rendered with -the `page` template, and included in the `post_list`, which can be -included in your site using the `post_list` template. +automatically treated as _blog posts_. This means they are rendered with the +`page` template, and included in the `post_list`, which can be included in your +site using the `post_list` template. ### Templates The `templates` directory may contain any `jinja2` template files. You may -modify the existing templates or create your own. To apply a certain -template to a page, set the `template` option in its -[frontmatter](#frontmatter). The following public variables are made -available to the template engine: +modify the existing templates or create your own. To apply a certain template to +a page, set the `template` option in its [frontmatter](#frontmatter). The +following public variables are made available to the template engine: | Name | Description | | ---------- | ------------------------------------------------------ | @@ -201,43 +205,40 @@ available to the template engine: #### Markdown Footer -The `templates` directory can contain a file called `footer.md`. If it -exists, it's parsed and rendered into HTML, then made available to other -templates as the `footer` variable. If `footer.md` is missing but -`footer.html` exists, then it's used instead. **Note: links are _not_ -resolved in the footer.** +The `templates` directory can contain a file called `footer.md`. If it exists, +it's parsed and rendered into HTML, then made available to other templates as +the `footer` variable. If `footer.md` is missing but `footer.html` exists, then +it's used instead. **Note: links are _not_ resolved in the footer.** ### Internal Link Resolution -When zona encounters links in Markdown documents, it attempts to resolve -them as internal links. Links beginning with `/` are resolved relative to -the content root; otherwise, they are resolved relative to the Markdown -file. If the link resolves to an existing file that is part of the -website, it's replaced with an appropriate web-server-friendly link. -Otherwise, the link isn't changed. +When zona encounters links in Markdown documents, it attempts to resolve them as +internal links. Links beginning with `/` are resolved relative to the content +root; otherwise, they are resolved relative to the Markdown file. If the link +resolves to an existing file that is part of the website, it's replaced with an +appropriate web-server-friendly link. Otherwise, the link isn't changed. -For example, suppose the file `blog/post1.md` has a link `./post2.md`. The -HTML output will contain the link `/blog/post2` (which corresponds to -`/blog/post2/index.html`). Link resolution is applied to _all_ internal -links, including those pointing to static resources like images. Links are -only modified if they point to a real file that's not included in the -ignore list. +For example, suppose the file `blog/post1.md` has a link `./post2.md`. The HTML +output will contain the link `/blog/post2` (which corresponds to +`/blog/post2/index.html`). Link resolution is applied to _all_ internal links, +including those pointing to static resources like images. Links are only +modified if they point to a real file that's not included in the ignore list. ### Syntax Highlighting -Zona uses [Pygments] to provide syntax highlighting for fenced code -blocks. The following Pygments plugins are included: +Zona uses [Pygments] to provide syntax highlighting for fenced code blocks. The +following Pygments plugins are included: -- [pygments-kakoune](https://git.sr.ht/~ficd/pygments-kakoune) - - A lexer providing for highlighting Kakoune code. Available under the - `kak` and `kakrc` aliases. -- [pygments-ashen](https://git.sr.ht/~ficd/ashen/tree/main/item/pygments/README.md) - - An implementation of the [Ashen](https://git.sr.ht/~ficd/ashen) theme - for Pygments. +- [pygments-kakoune](https://codeberg.com/ficd/pygments-kakoune) + - A lexer providing for highlighting Kakoune code. Available under the `kak` + and `kakrc` aliases. +- [pygments-ashen](https://codeberg.com/ficd/ashen/tree/main/item/pygments/README.md) + - An implementation of the [Ashen](https://codeberg.com/ficd/ashen) theme for + Pygments. If you want to use any external Pygments styles or lexers, they must be -available in zona's Python environment. For example, you can give zona -access to [Catppucin](https://github.com/catppuccin/python): +available in zona's Python environment. For example, you can give zona access to +[Catppucin](https://github.com/catppuccin/python): ```yaml # config.yml @@ -252,9 +253,9 @@ Then, run zona with the following `uv` command: uvx --with catppucin zona build ``` -Inline syntax highlighting is also provided via a `python-markdown` -extension. If you prefix inline code with a shebang followed by the -language identifier, it will be highlighted. For example: +Inline syntax highlighting is also provided via a `python-markdown` extension. +If you prefix inline code with a shebang followed by the language identifier, it +will be highlighted. For example: ``` `#!python print(f"I love {foobar}!", end="")` @@ -280,10 +281,9 @@ will be rendered as ### Image Labels -A feature unique to zona is **image labels**. They make it easy to -annotate images in your Markdown documents. The alt text Markdown element -is rendered as the label — with support for inline Markdown. Consider this -example: +A feature unique to zona is **image labels**. They make it easy to annotate +images in your Markdown documents. The alt text Markdown element is rendered as +the label — with support for inline Markdown. Consider this example: ```markdown ![This **image** has _markup_.](static/markdown.png) @@ -298,14 +298,14 @@ The above results in the following HTML: ``` The `image-container` class is provided as a convenience for styling. The -default stylesheet centers the label under the image. Note: _links_ inside -image captions are not currently supported. I am looking into a solution. +default stylesheet centers the label under the image. Note: _links_ inside image +captions are not currently supported. I am looking into a solution. ### Frontmatter -YAML frontmatter can be used to configure the metadata of documents. All -of them are optional. `none` is used when the option is unset. The -following options are available: +YAML frontmatter can be used to configure the metadata of documents. All of them +are optional. `none` is used when the option is unset. The following options are +available: | Key | Type & Default | Description | | ------------ | --------------------------------- | ------------------------------------------------------------------------------------------------------ | @@ -338,10 +338,9 @@ template: post_list Welcome to my blog! Please find a list of my posts below. ``` -Setting `post: false` is necessary because, by default, all documents -inside `content/blog` are considered to be posts unless explicitly -disabled in the frontmatter. We don't want the post list to list _itself_ -as a post. +Setting `post: false` is necessary because, by default, all documents inside +`content/blog` are considered to be posts unless explicitly disabled in the +frontmatter. We don't want the post list to list _itself_ as a post. Then, you'd create `content/blog/my-post.md` and populate it: @@ -352,32 +351,32 @@ date: July 5, 2025 --- ``` -Because `my-post` is inside the `blog` directory, `post: true` is implied. -If you wanted to put it somewhere outside `blog`, you would need to set +Because `my-post` is inside the `blog` directory, `post: true` is implied. If +you wanted to put it somewhere outside `blog`, you would need to set `post: true` for it to be included in the post list. ## Configuration -Zona is configured in YAML format. The configuration file is called -`config.yml` and it **must** be located in the root of the project — in -the same directory as `content` and `templates`. +Zona is configured in YAML format. The configuration file is called `config.yml` +and it **must** be located in the root of the project — in the same directory as +`content` and `templates`. -Your configuration will be merged with the defaults. `zona init` also -writes a copy of the default configuration to the correct location. If it -exists, you'll be prompted before overwriting it. +Your configuration will be merged with the defaults. `zona init` also writes a +copy of the default configuration to the correct location. If it exists, you'll +be prompted before overwriting it. -**Note:** Currently, not every configuration value is actually used. Only -the useful settings are listed here. +**Note:** Currently, not every configuration value is actually used. Only the +useful settings are listed here. Please see the default configuration: ```yaml +base_url: / sitemap: Home: / ignore: - .marksman.toml markdown: - image_labels: true tab_length: 2 syntax_highlighting: enabled: true @@ -385,49 +384,60 @@ markdown: wrap: false links: external_new_tab: true +build: + clean_output_dir: true + include_drafts: false blog: dir: blog +server: + reload: + enabled: true + scroll_tolerance: 100 ``` -| Name | Description | -| -------------------------------------- | --------------------------------------------------------------------------------------------- | -| `sitemap` | Sitemap dictionary. See [Sitemap](#sitemap). | -| `ignore` | List of paths to ignore. See [Ignore List](#ignore-list). | -| `markdown.tab_length` | How many spaces should be considered an indentation level. | -| `markdown.syntax_highlighting.enabled` | Whether code should be highlighted. | -| `markdown.syntax_highlighting.theme` | [Pygments] style for highlighting. | -| `markdown.syntax_highlighting.wrap` | Whether the resulting code block should be word wrapped. | -| `markdown.links.external_new_tab` | Whether external links should be opened in a new tab. | -| `blog.dir` | Name of a directory relative to `content/` whose children are automatically considered posts. | +| Name | Description | +| -------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `sitemap` | Sitemap dictionary. See [Sitemap](#sitemap). | +| `ignore` | List of paths to ignore. See [Ignore List](#ignore-list). | +| `markdown.tab_length` | How many spaces should be considered an indentation level. | +| `markdown.syntax_highlighting.enabled` | Whether code should be highlighted. | +| `markdown.syntax_highlighting.theme` | [Pygments] style for highlighting. | +| `markdown.syntax_highlighting.wrap` | Whether the resulting code block should be word wrapped. | +| `markdown.links.external_new_tab` | Whether external links should be opened in a new tab. | +| `build.clean_output_dir` | Whether previous build artifacts should be cleared when building. Recommended to leave this on. | +| `build.include_drafts` | Whether drafts should be included by default. | +| `blog.dir` | Name of a directory relative to `content/` whose children are automatically considered posts. | +| `server.reload.enabled` | Whether the preview server should use [live reload](#live-preview). | +| `server.reload.scroll_tolerance` | The distance, in pixels, from the bottom to still count as "scrolled to bottom". | ### Sitemap -You can define a sitemap in the configuration file. This is a list of -links that will be rendered at the top of every page. The `sitemap` is a -dictionary of `string` to `string` pairs, where each key is the displayed -text of the link, and the value if the `href`. Consider this example: +You can define a sitemap in the configuration file. This is a list of links that +will be rendered at the top of every page. The `sitemap` is a dictionary of +`string` to `string` pairs, where each key is the displayed text of the link, +and the value if the `href`. Consider this example: ```yaml sitemap: Home: / About: /about Blog: /blog - Git: https://git.sr.ht/~ficd + Git: https://git.ficd.sh/ficd ``` ### Ignore List -You can set a list of glob patterns in the [configuration](#configuration) -that should be ignored by zona. This is useful because zona makes a copy -of _every_ file it encounters inside the `content` directory, regardless -of its type. The paths must be relative to the `content` directory. +You can set a list of glob patterns in the [configuration](#configuration) that +should be ignored by zona. This is useful because zona makes a copy of _every_ +file it encounters inside the `content` directory, regardless of its type. The +paths must be relative to the `content` directory. ### Drafts -zona allows you to begin writing content without including it in the final -build output. If you set `draft: true` in a page's frontmatter, it will be -marked as a draft. Drafts are completely excluded from `zona build` and -`zona serve` unless the `--draft` flag is specified. +zona allows you to begin writing content without including it in the final build +output. If you set `draft: true` in a page's frontmatter, it will be marked as a +draft. Drafts are completely excluded from `zona build` and `zona serve` unless +the `--draft` flag is specified. -[Ashen]: https://sr.ht/~ficd/ashen +[Ashen]: https://codeberg.com/ficd/ashen [Pygments]: https://pygments.org/ diff --git a/src/zona/cli.py b/src/zona/cli.py index 1d32c4c..a7e2dd5 100644 --- a/src/zona/cli.py +++ b/src/zona/cli.py @@ -95,14 +95,15 @@ def serve( bool, typer.Option("--final", "-f", help="Don't include drafts."), ] = False, - no_live_reload: Annotated[ - bool, + live_reload: Annotated[ + bool | None, typer.Option( - "--no-live-reload", - "-n", - help="Don't automatically reload web preview.", + "--live-reload/--no-live-reload", + "-l/-L", + help="Automatically reload web preview. Overrides config.", + show_default=False, ), - ] = False, + ] = None, ): """ Build the website and start a live preview server. @@ -115,13 +116,17 @@ def serve( print("Preview without drafts.") else: print("Preview with drafts.") + if live_reload is None: + reload = None + else: + reload = live_reload server.serve( root=root, output=output, draft=not final, host=host, port=port, - live_reload=not no_live_reload, + user_reload=reload, ) diff --git a/src/zona/config.py b/src/zona/config.py index 4bd7a42..cc56ec2 100644 --- a/src/zona/config.py +++ b/src/zona/config.py @@ -58,6 +58,17 @@ class BuildConfig: include_drafts: bool = False +@dataclass +class ReloadConfig: + enabled: bool = True + scroll_tolerance: int = 100 + + +@dataclass +class ServerConfig: + reload: ReloadConfig = field(default_factory=ReloadConfig) + + IGNORELIST = [".marksman.toml"] @@ -71,6 +82,7 @@ class ZonaConfig: markdown: MarkdownConfig = field(default_factory=MarkdownConfig) build: BuildConfig = field(default_factory=BuildConfig) blog: BlogConfig = field(default_factory=BlogConfig) + server: ServerConfig = field(default_factory=ServerConfig) @classmethod def from_file(cls, path: Path) -> "ZonaConfig": diff --git a/src/zona/data/server/inject.js b/src/zona/data/server/inject.js index d199c03..bc00dde 100644 --- a/src/zona/data/server/inject.js +++ b/src/zona/data/server/inject.js @@ -9,12 +9,13 @@ }); } - const ws = new WebSocket("__SOCKET_ADDRESS_"); + const ws = new WebSocket("__SOCKET_ADDRESS__"); + const tol = __SCROLL_TOLERANCE__; ws.onmessage = event => { if (event.data === "reload") { // store flag if user currently at bottom const nearBottom = window.innerHeight + window.scrollY - >= document.body.scrollHeight - 100; + >= document.body.scrollHeight - tol; if (nearBottom) { localStorage.setItem("wasAtBottom", "1"); } diff --git a/src/zona/server.py b/src/zona/server.py index b2e0a64..23c4c0b 100644 --- a/src/zona/server.py +++ b/src/zona/server.py @@ -21,17 +21,22 @@ from zona.websockets import WebSocketServer logger = get_logger() -def make_reload_script(host: str, port: int) -> str: +def make_reload_script( + host: str, port: int, scroll_tolerance: int +) -> str: """Generates the JavaScript that must be injected into HTML pages for the live reloading to work.""" js = util.get_resource("server/inject.js").contents js = util.minify_js(js) address = f"ws://{host}:{port}" - for placeholder, value in (("__SOCKET_ADDRESS_", address),): + for placeholder, value in ( + ("__SOCKET_ADDRESS__", address), + ("__SCROLL_TOLERANCE__", scroll_tolerance), + ): if placeholder not in js: raise ValueError( f"{placeholder} missing from reload script template!" ) - js = js.replace(placeholder, value) + js = js.replace(placeholder, str(value)) return f"" @@ -172,12 +177,13 @@ def serve( draft: bool = True, host: str = "localhost", port: int = 8000, - live_reload: bool = True, + user_reload: bool | None = None, ): """Serve preview website with live reload and automatic rebuild.""" # create temp dir, automatic cleanup with tempfile.TemporaryDirectory() as tmp: builder = ZonaBuilder(root, Path(tmp), draft) + config = builder.config # initial site build builder.build() # use discovered paths if none provided @@ -186,13 +192,21 @@ def serve( if root is None: root = builder.layout.root - # spin up websocket server for live reloading - if live_reload: + # use config value unless overridden by user + reload = config.server.reload.enabled + if user_reload is not None: + reload = user_reload + if reload: + print("Live reloading is enabled.") + # spin up websocket server for live reloading ws_port = port + 1 ws_server = WebSocketServer(host, ws_port) ws_server.start() # generate reload script for injection - reload_script = make_reload_script(host, ws_port) + scroll_tolerance = config.server.reload.scroll_tolerance + reload_script = make_reload_script( + host, ws_port, scroll_tolerance + ) # generate handler with reload script as attribute handler = make_handler_class(reload_script) else: From 0166e82cce3932f22fef5fa58f127dd09b08d79e Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sun, 13 Jul 2025 18:24:56 -0400 Subject: [PATCH 07/26] updated readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index df3c866..1fbb3e4 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,8 @@ the previous codebase (which is feature incomplete), visit the [zona-go](https://git.ficd.sh/ficd/zona-go) repository. For an example of a website built with zona, please see -[ficd.sh](https://ficd.sh). +[ficd.sh](https://ficd.sh). For a list of known problems, see +[Known Problems](#known-problems). @@ -44,6 +45,7 @@ For an example of a website built with zona, please see - [Sitemap](#sitemap) - [Ignore List](#ignore-list) - [Drafts](#drafts) +- [Known Problems](#known-problems) @@ -441,3 +443,13 @@ the `--draft` flag is specified. [Ashen]: https://codeberg.com/ficd/ashen [Pygments]: https://pygments.org/ + +## Known Problems + +1. If the user triggers rebuilds in quick succession, the browser is sent the + reload command after the first build, even though a second build may be + underway. This results in a `404` page being served, and the user needs to + manually refresh the browser page. + + **Mitigation:** Don't allow a rebuild until the browser has re-connected to + the WebSocket after the first reload. From 46934e502f242e47d890c5b1efc156b047946600 Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sun, 13 Jul 2025 21:25:20 -0400 Subject: [PATCH 08/26] update readme --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1fbb3e4..dcccab2 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,6 @@ engine. However, if you're looking for something stable, complete, and fully configurable, zona may not be for you. If you want a minimal Markdown blog and are comfortable with modifying `jinja2` templates and CSS, then you're in luck. -**Note:** This project is in early development, there are no versioned releases -yet, and breaking changes are likely. Versioned releases will be made and zona -will be published to PyPI once it's stable. zona was previously implemented in -Go; I decided to rewrite the project in Python. If you're interested in seeing -the previous codebase (which is feature incomplete), visit the -[zona-go](https://git.ficd.sh/ficd/zona-go) repository. - For an example of a website built with zona, please see [ficd.sh](https://ficd.sh). For a list of known problems, see [Known Problems](#known-problems). @@ -74,11 +67,16 @@ For an example of a website built with zona, please see ## Installation -zona is not yet packaged on PyPI. You may use `uv` to install it from this -repository: +Zona can be installed as a Python package. Instructions for +[`uv`](https://docs.astral.sh/uv/) are provided. ```sh +# install latest release +uv tool install zona +# install bleeding edge from git uv tool install 'git+https://git.ficd.sh/ficd/zona' +# you can also run without installation +uvx zona build --help ``` ## Usage From a789d1f64ee1714f023f95b53785a425f73617d8 Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sun, 13 Jul 2025 21:28:00 -0400 Subject: [PATCH 09/26] changed license to BSD-3 --- LICENSE | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/LICENSE b/LICENSE index ac101d3..1cbda58 100644 --- a/LICENSE +++ b/LICENSE @@ -1,13 +1,24 @@ -Copyright (c) 2025 Daniel Fichtinger +Copyright (c) 2025 Daniel Fichtinger -Permission to use, copy, modify, and distribute this software for any -purpose with or without fee is hereby granted, provided that the above -copyright notice and this permission notice appear in all copies. +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. +3. Neither the name of the author nor the names of its contributors may + be used to endorse or promote products derived from this software -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +SUCH DAMAGE. From 0e320241474f37c9e6afeecd576483b8a6c25e42 Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sun, 13 Jul 2025 21:29:15 -0400 Subject: [PATCH 10/26] update metadata for release --- pyproject.toml | 11 ++++++++--- uv.lock | 2 +- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index aea7a42..3af55b6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,10 +1,12 @@ [project] name = "zona" -version = "0.1.0" -description = "Static site generator" +version = "1.0.0" +description = "Opinionated static site generator." +license = "BSD-3" +license-files = ["LICENSE"] readme = "README.md" authors = [ - { name = "Daniel Fichtinger", email = "daniel@ficd.ca" }, + { name = "Daniel Fichtinger", email = "daniel@ficd.sh" }, ] requires-python = ">=3.12" dependencies = [ @@ -24,6 +26,9 @@ dependencies = [ "websockets>=15.0.1", ] +[project.urls] +Repository = "https://git.ficd.sh/ficd/zona" + [project.scripts] zona = "zona.cli:main" diff --git a/uv.lock b/uv.lock index 311053e..af06654 100644 --- a/uv.lock +++ b/uv.lock @@ -459,7 +459,7 @@ wheels = [ [[package]] name = "zona" -version = "0.1.0" +version = "1.0.0" source = { editable = "." } dependencies = [ { name = "dacite" }, From db8318622c350b1230c16be669c8534f44320813 Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sun, 13 Jul 2025 21:32:24 -0400 Subject: [PATCH 11/26] fixed license identifier in pyproject --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 3af55b6..caf20fb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,7 +2,7 @@ name = "zona" version = "1.0.0" description = "Opinionated static site generator." -license = "BSD-3" +license = "BSD-3-Clause " license-files = ["LICENSE"] readme = "README.md" authors = [ From e69dd808755c5ae6f853a8b7909d9786fb1c9dc8 Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sun, 13 Jul 2025 21:33:36 -0400 Subject: [PATCH 12/26] updated just recipes --- justfile | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/justfile b/justfile index cfb1ed2..c0f2e14 100644 --- a/justfile +++ b/justfile @@ -2,6 +2,28 @@ default: @just --list +clean: + #!/bin/sh + if [ ! -d "dist" ] && [ ! -d "__pycache__" ]; then + echo "Nothing to clean." + exit 0 + fi + if [ -d "dist" ]; then + echo "Removing dist/" + rm -r dist/ + fi + if [ -d "__pycache__" ]; then + echo "Removing __pycache__/" + rm -r "__pycache__" + fi + +publish: + #!/bin/sh + just clean + uv build + export UV_PUBLISH_TOKEN="$(pass show pypi)" + uv publish + format: uv run ruff format From 8b849fd2a0e3c4087806b6acd6b401a53edd0560 Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sun, 13 Jul 2025 21:59:53 -0400 Subject: [PATCH 13/26] ci: added pypi release workflow --- .forgejo/workflows/publish.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .forgejo/workflows/publish.yml diff --git a/.forgejo/workflows/publish.yml b/.forgejo/workflows/publish.yml new file mode 100644 index 0000000..7641a33 --- /dev/null +++ b/.forgejo/workflows/publish.yml @@ -0,0 +1,22 @@ +on: + push: + tags: + - 'v*' +jobs: + publish: + runs-on: docker + container: + image: node:alpine + steps: + - name: Install dependencies + run: | + apk add --no-cache coreutils uv + - uses: actions/checkout@v4 + - name: build + run: | + uv sync + uv build + - name: publish + run: | + uv publish --token ${{ secrets.PYPI_TOKEN }} + From e28a206067b17d52f678adb1c9d33a8b7dd55f77 Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sun, 13 Jul 2025 23:42:51 -0400 Subject: [PATCH 14/26] update publish workflow to use based-alpine --- .forgejo/workflows/publish.yml | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/.forgejo/workflows/publish.yml b/.forgejo/workflows/publish.yml index 7641a33..53dd92f 100644 --- a/.forgejo/workflows/publish.yml +++ b/.forgejo/workflows/publish.yml @@ -4,13 +4,8 @@ on: - 'v*' jobs: publish: - runs-on: docker - container: - image: node:alpine + runs-on: based-alpine steps: - - name: Install dependencies - run: | - apk add --no-cache coreutils uv - uses: actions/checkout@v4 - name: build run: | From faac8f63bbf960bb41fb99924db46533cd7c203d Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Mon, 14 Jul 2025 15:00:54 -0400 Subject: [PATCH 15/26] major updates to default stylesheet --- src/zona/data/content/static/style.css | 67 +++++++++++++++++++++++--- 1 file changed, 59 insertions(+), 8 deletions(-) diff --git a/src/zona/data/content/static/style.css b/src/zona/data/content/static/style.css index 284a5ce..56bbae9 100644 --- a/src/zona/data/content/static/style.css +++ b/src/zona/data/content/static/style.css @@ -1,14 +1,17 @@ :root { --main-text-color: #b4b4b4; + --main-text-opaque-color: rgba(180, 180, 180, 0.8); --main-bg-color: #121212; --main-link-color: #df6464; --main-heading-color: #df6464; --main-bullet-color: #d87c4a; + --orange-rgb: rgba(216, 124, 74, 0.6); --main-transparent: rgba(255, 255, 255, 0.15); --main-small-text-color: rgba(255, 255, 255, 0.45); } body { + margin: 0; line-height: 1.6; font-size: 18px; font-family: sans-serif; @@ -17,6 +20,20 @@ body { padding-left: calc(100vw - 100%); } +header { + padding-top: -1rem; + margin-top: -1rem; + font-family: monospace; + text-transform: lowercase; +} + +.site-logo { + color: inherit; + font-weight: bold; + text-decoration: none; + /* font-size: 1.75rem;*/ +} + .toclink { position: relative; text-decoration: none; @@ -128,11 +145,28 @@ li::marker { a { color: var(--main-link-color); - text-decoration: underline; + text-decoration: none; + position: relative; } -a:hover { - background: var(--main-transparent); +a::after { + content: ""; + position: absolute; + left: 0; + bottom: -2px; + width: 100%; + height: 1px; + background-color: currentColor; + transform: scaleX(0); + transform-origin: center; + transition: transform 0.1s ease; +} + +a:hover::after { + transform: scaleX(1); +} +a:has(> code)::after { + display: none; } max-width: 100%; @@ -146,8 +180,8 @@ img { } blockquote { - color: var(--main-small-text-color); - border-left: 3px solid var(--main-transparent); + color: var(--main-text-opaque-color); + border-left: 3px solid var(--orange-rgb); padding: 0 1rem; margin-left: 0; margin-right: 0; @@ -157,6 +191,16 @@ hr { border: none; height: 1px; background: var(--main-small-text-color); + opacity: 0.5; +} + +time { + color: var(--main-bullet-color); + font-family: monospace; +} + +.post-list-date { + font-size: 0.95rem; } code { @@ -183,7 +227,7 @@ pre { } pre { - background-color: #151515; + background-color: #1d1d1d; color: #d5d5d5; padding: 1em; border-radius: 5px; @@ -362,13 +406,20 @@ caption { a > code { text-decoration: none; - color: inherit; + color: var(--main-link-color); + position: relative; } a:has(> code) { text-decoration: none; + background: none; + /* position: static;*/ } a:hover > code { - background-color: var(--main-transparent); + text-decoration: underline; +} + +a:hover:has(> code) { + background: none; } From 04948a93739f1d80c53cf4d63882733e19bb597b Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Mon, 14 Jul 2025 16:04:05 -0400 Subject: [PATCH 16/26] formatted python files --- src/zona/builder.py | 20 ++++++++++++++------ src/zona/cli.py | 8 ++++++-- src/zona/config.py | 4 +++- src/zona/server.py | 4 +++- src/zona/util.py | 11 ++++++++--- 5 files changed, 34 insertions(+), 13 deletions(-) diff --git a/src/zona/builder.py b/src/zona/builder.py index 12b5458..a04b2eb 100644 --- a/src/zona/builder.py +++ b/src/zona/builder.py @@ -48,7 +48,9 @@ class ZonaBuilder: destination=destination, url=str(destination.relative_to(layout.output)), ) - if path.name.endswith(".md") and not path.is_relative_to( + if path.name.endswith( + ".md" + ) and not path.is_relative_to( layout.root / "content" / "static" ): logger.debug(f"Parsing {path.name}.") @@ -69,11 +71,13 @@ class ZonaBuilder: item.copy = False name = destination.stem if name == "index": - item.destination = item.destination.with_suffix( - ".html" + item.destination = ( + item.destination.with_suffix(".html") ) else: - relative = path.relative_to(base).with_suffix("") + relative = path.relative_to(base).with_suffix( + "" + ) name = relative.stem item.destination = ( layout.output @@ -85,7 +89,9 @@ class ZonaBuilder: layout.output ) item.url = ( - "" if rel_url == Path(".") else rel_url.as_posix() + "" + if rel_url == Path(".") + else rel_url.as_posix() ) items.append(item) self.items = items @@ -111,7 +117,9 @@ class ZonaBuilder: # write code highlighting stylesheet if self.config.markdown.syntax_highlighting.enabled: pygments_style = zmd.get_style_defs(self.config) - pygments_path = self.layout.output / "static" / "pygments.css" + pygments_path = ( + self.layout.output / "static" / "pygments.css" + ) util.ensure_parents(pygments_path) pygments_path.write_text(pygments_style) for item in self.item_map.values(): diff --git a/src/zona/cli.py b/src/zona/cli.py index a7e2dd5..4b48d3a 100644 --- a/src/zona/cli.py +++ b/src/zona/cli.py @@ -59,7 +59,9 @@ def build( """ if draft: print("Option override: including drafts.") - builder = ZonaBuilder(cli_root=root, cli_output=output, draft=draft) + builder = ZonaBuilder( + cli_root=root, cli_output=output, draft=draft + ) builder.build() @@ -73,7 +75,9 @@ def serve( ] = None, host: Annotated[ str, - typer.Option("--host", help="Hostname for live preview server."), + typer.Option( + "--host", help="Hostname for live preview server." + ), ] = "localhost", port: Annotated[ int, diff --git a/src/zona/config.py b/src/zona/config.py index cc56ec2..2a50fd4 100644 --- a/src/zona/config.py +++ b/src/zona/config.py @@ -76,7 +76,9 @@ IGNORELIST = [".marksman.toml"] class ZonaConfig: base_url: str = "/" # dictionary where key is name, value is url - sitemap: SitemapConfig = field(default_factory=lambda: {"Home": "/"}) + sitemap: SitemapConfig = field( + default_factory=lambda: {"Home": "/"} + ) # list of globs relative to content that should be ignored ignore: list[str] = field(default_factory=lambda: IGNORELIST) markdown: MarkdownConfig = field(default_factory=MarkdownConfig) diff --git a/src/zona/server.py b/src/zona/server.py index 23c4c0b..82e6381 100644 --- a/src/zona/server.py +++ b/src/zona/server.py @@ -238,7 +238,9 @@ def serve( event_handler, path=str(root / "content"), recursive=True ) observer.schedule( - event_handler, path=str(root / "templates"), recursive=True + event_handler, + path=str(root / "templates"), + recursive=True, ) observer.start() diff --git a/src/zona/util.py b/src/zona/util.py index 2d5c514..9ccc2c6 100644 --- a/src/zona/util.py +++ b/src/zona/util.py @@ -19,7 +19,9 @@ def get_resource(path: str) -> ZonaResource: if file.is_file(): return ZonaResource(name=path, contents=file.read_text()) else: - raise FileNotFoundError(f"{path} is not a valid Zona resource!") + raise FileNotFoundError( + f"{path} is not a valid Zona resource!" + ) def get_resources(subdir: str) -> list[ZonaResource]: @@ -75,10 +77,13 @@ def normalize_url(url: str) -> str: return url -def should_ignore(path: Path, patterns: list[str], base: Path) -> bool: +def should_ignore( + path: Path, patterns: list[str], base: Path +) -> bool: rel_path = path.relative_to(base) return any( - fnmatch.fnmatch(str(rel_path), pattern) for pattern in patterns + fnmatch.fnmatch(str(rel_path), pattern) + for pattern in patterns ) From 27178dc6d8c0f43dfa9da56db8e9d772bc99ffa0 Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Mon, 14 Jul 2025 16:06:24 -0400 Subject: [PATCH 17/26] updated formatter config --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index caf20fb..2a2e6b4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -62,7 +62,7 @@ allowedUntypedLibraries = ["frontmatter", "pygments", "pymdownx", "l2m4m"] [tool.ruff] line-length = 70 indent-width = 4 -target-version = "py311" +target-version = "py312" [tool.ruff.lint] fixable = ["ALL"] From 07152a37468309a57e9fef6698f5bed65807e4bd Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Mon, 14 Jul 2025 16:11:47 -0400 Subject: [PATCH 18/26] feat: ignore frontmatter option --- README.md | 1 + src/zona/builder.py | 22 +++++++--------------- src/zona/metadata.py | 1 + 3 files changed, 9 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index dcccab2..d46a69b 100644 --- a/README.md +++ b/README.md @@ -317,6 +317,7 @@ available: | `template` | `str \| none` = `none` | Template to use for this page. Relative to `templates/`, `.html` extension optional. | | `post` | `bool \| none` = `none` | Whether this page is a **post**. `true`/`false` is _absolute_. Leave it unset for automatic detection. | | `draft` | `bool` = `false` | Whether this page is a draft. See [drafts](#drafts) for more. | +| `ignore` | `bool` = `false` | Whether this page should be ignored in _both_ `final` and `draft` contexts. | | `math` | `bool` = `true` | Whether the LaTeX extension should be enabled for this page. | **Note**: you can specify the date in any format that can be parsed by diff --git a/src/zona/builder.py b/src/zona/builder.py index a04b2eb..446f07d 100644 --- a/src/zona/builder.py +++ b/src/zona/builder.py @@ -48,14 +48,12 @@ class ZonaBuilder: destination=destination, url=str(destination.relative_to(layout.output)), ) - if path.name.endswith( - ".md" - ) and not path.is_relative_to( + if path.name.endswith(".md") and not path.is_relative_to( layout.root / "content" / "static" ): logger.debug(f"Parsing {path.name}.") item.metadata, item.content = parse_metadata(path) - if ( + if item.metadata.ignore or ( item.metadata.draft and not self.config.build.include_drafts ): @@ -71,13 +69,11 @@ class ZonaBuilder: item.copy = False name = destination.stem if name == "index": - item.destination = ( - item.destination.with_suffix(".html") + item.destination = item.destination.with_suffix( + ".html" ) else: - relative = path.relative_to(base).with_suffix( - "" - ) + relative = path.relative_to(base).with_suffix("") name = relative.stem item.destination = ( layout.output @@ -89,9 +85,7 @@ class ZonaBuilder: layout.output ) item.url = ( - "" - if rel_url == Path(".") - else rel_url.as_posix() + "" if rel_url == Path(".") else rel_url.as_posix() ) items.append(item) self.items = items @@ -117,9 +111,7 @@ class ZonaBuilder: # write code highlighting stylesheet if self.config.markdown.syntax_highlighting.enabled: pygments_style = zmd.get_style_defs(self.config) - pygments_path = ( - self.layout.output / "static" / "pygments.css" - ) + pygments_path = self.layout.output / "static" / "pygments.css" util.ensure_parents(pygments_path) pygments_path.write_text(pygments_style) for item in self.item_map.values(): diff --git a/src/zona/metadata.py b/src/zona/metadata.py index b079266..0cd6a8c 100644 --- a/src/zona/metadata.py +++ b/src/zona/metadata.py @@ -24,6 +24,7 @@ class Metadata: template: str | None = None post: bool | None = None draft: bool = False + ignore: bool = False math: bool = True From 2bc12ff2edc7b4d23320b799d7e0143e996e50d6 Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Mon, 14 Jul 2025 16:24:14 -0400 Subject: [PATCH 19/26] refactored title in templates now has "title" class for easier styling --- src/zona/data/templates/basic.html | 4 +--- src/zona/data/templates/page.html | 16 ++++++---------- src/zona/data/templates/post_list.html | 24 +++++++++++------------- src/zona/data/templates/title.html | 4 ++++ 4 files changed, 22 insertions(+), 26 deletions(-) create mode 100644 src/zona/data/templates/title.html diff --git a/src/zona/data/templates/basic.html b/src/zona/data/templates/basic.html index 033d9e3..caddc62 100644 --- a/src/zona/data/templates/basic.html +++ b/src/zona/data/templates/basic.html @@ -1,9 +1,7 @@ {% extends "base.html" %} {% block content %} -{% if metadata.show_title %} -

{{ metadata.title }}

-{% endif %} +{% include "title.html" %} {{ content | safe }} {% endblock %} diff --git a/src/zona/data/templates/page.html b/src/zona/data/templates/page.html index 3e835b4..96250f1 100644 --- a/src/zona/data/templates/page.html +++ b/src/zona/data/templates/page.html @@ -1,13 +1,9 @@ -{% extends "base.html" %} - -{% block content %} -{% if metadata.show_title %} -

{{ metadata.title }}

-{% endif %} -{% if metadata.date %} -
+{% extends "base.html" %} {% block content %} {% include "title.html" %} {% if +metadata.date %} +
+ +
{% endif %}
{{ content | safe }}
{% endblock %} - - diff --git a/src/zona/data/templates/post_list.html b/src/zona/data/templates/post_list.html index 8545020..8c849ee 100644 --- a/src/zona/data/templates/post_list.html +++ b/src/zona/data/templates/post_list.html @@ -1,17 +1,15 @@ -{% extends "base.html" %} - -{% block content %} - -

{{ metadata.title }}

+{% extends "base.html" %} {% block content %} {% include "title.html" %}
{{ content | safe }}
{% if post_list %} - -{% endif %} -{% endblock %} - + +{% endif %} {% endblock %} diff --git a/src/zona/data/templates/title.html b/src/zona/data/templates/title.html new file mode 100644 index 0000000..246f83b --- /dev/null +++ b/src/zona/data/templates/title.html @@ -0,0 +1,4 @@ +{% if metadata.show_title %} +

{{ metadata.title }}

+
+{% endif %} From de86a92928c77570b104318d7baccd85877c894c Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Mon, 14 Jul 2025 16:24:28 -0400 Subject: [PATCH 20/26] added title styling to default stylesheet --- src/zona/data/content/static/style.css | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/zona/data/content/static/style.css b/src/zona/data/content/static/style.css index 56bbae9..9e5633e 100644 --- a/src/zona/data/content/static/style.css +++ b/src/zona/data/content/static/style.css @@ -90,6 +90,11 @@ h1 { font-weight: bold; } +.title { + text-transform: lowercase; + font-family: monospace; +} + article h1:first-of-type { margin-block-start: 1.67rem; } From 24919171ad4cdedc30368c6f17ce8584bcbf512d Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Mon, 14 Jul 2025 16:34:17 -0400 Subject: [PATCH 21/26] fixed structure of page date in templates --- src/zona/data/templates/basic.html | 2 ++ src/zona/data/templates/page.html | 13 +++++++++++-- src/zona/data/templates/post_list.html | 7 ++++++- src/zona/data/templates/title.html | 4 +--- 4 files changed, 20 insertions(+), 6 deletions(-) diff --git a/src/zona/data/templates/basic.html b/src/zona/data/templates/basic.html index caddc62..d86a25a 100644 --- a/src/zona/data/templates/basic.html +++ b/src/zona/data/templates/basic.html @@ -1,7 +1,9 @@ {% extends "base.html" %} {% block content %} +{% if metadata.show_title %} {% include "title.html" %} +{% endif %} {{ content | safe }} {% endblock %} diff --git a/src/zona/data/templates/page.html b/src/zona/data/templates/page.html index 96250f1..fd3cdb4 100644 --- a/src/zona/data/templates/page.html +++ b/src/zona/data/templates/page.html @@ -1,9 +1,18 @@ -{% extends "base.html" %} {% block content %} {% include "title.html" %} {% if -metadata.date %} +{% extends "base.html" %} {% block content %} + +{% if metadata.show_title %} +{% include "title.html" %} +{% if metadata.date %}
{% endif %} +
+{% endif %} +
{{ content | safe }}
{% endblock %} + + + diff --git a/src/zona/data/templates/post_list.html b/src/zona/data/templates/post_list.html index 8c849ee..85e0be8 100644 --- a/src/zona/data/templates/post_list.html +++ b/src/zona/data/templates/post_list.html @@ -1,4 +1,8 @@ -{% extends "base.html" %} {% block content %} {% include "title.html" %} +{% extends "base.html" %} {% block content %} + +{% if metadata.show_title %} +{% include "title.html" %} +{% endif %}
{{ content | safe }}
@@ -13,3 +17,4 @@ {% endfor %} {% endif %} {% endblock %} + diff --git a/src/zona/data/templates/title.html b/src/zona/data/templates/title.html index 246f83b..9753365 100644 --- a/src/zona/data/templates/title.html +++ b/src/zona/data/templates/title.html @@ -1,4 +1,2 @@ -{% if metadata.show_title %}

{{ metadata.title }}

-
-{% endif %} + From 404e951651f4192e6828078a725a51e257e9ebbe Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Mon, 14 Jul 2025 18:57:51 -0400 Subject: [PATCH 22/26] added smooth scroll to default stylesheet --- src/zona/data/content/static/style.css | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/zona/data/content/static/style.css b/src/zona/data/content/static/style.css index 9e5633e..d2cacf0 100644 --- a/src/zona/data/content/static/style.css +++ b/src/zona/data/content/static/style.css @@ -10,6 +10,10 @@ --main-small-text-color: rgba(255, 255, 255, 0.45); } +html { + scroll-behavior: smooth; +} + body { margin: 0; line-height: 1.6; From 933210c93b6ea9ad1f7b1d20099fb6784859e7b9 Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Mon, 14 Jul 2025 19:19:58 -0400 Subject: [PATCH 23/26] fixed crash on missing templates dir when starting server --- src/zona/server.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/src/zona/server.py b/src/zona/server.py index 82e6381..f8b0000 100644 --- a/src/zona/server.py +++ b/src/zona/server.py @@ -237,11 +237,13 @@ def serve( observer.schedule( event_handler, path=str(root / "content"), recursive=True ) - observer.schedule( - event_handler, - path=str(root / "templates"), - recursive=True, - ) + templates = root / "templates" + if templates.is_dir(): + observer.schedule( + event_handler, + path=str(templates), + recursive=True, + ) observer.start() # function to shut down gracefully From c489a6f0763c33e3725adba96dbc728f84b529ad Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Mon, 14 Jul 2025 20:15:40 -0400 Subject: [PATCH 24/26] added post-nav to posts --- src/zona/builder.py | 7 +++++++ src/zona/data/content/static/style.css | 12 ++++++++++++ src/zona/data/templates/page.html | 14 ++++---------- src/zona/data/templates/post_nav.html | 9 +++++++++ src/zona/metadata.py | 2 ++ src/zona/models.py | 4 ++++ src/zona/templates.py | 6 ++++++ 7 files changed, 44 insertions(+), 10 deletions(-) create mode 100644 src/zona/data/templates/post_nav.html diff --git a/src/zona/builder.py b/src/zona/builder.py index 446f07d..c53701e 100644 --- a/src/zona/builder.py +++ b/src/zona/builder.py @@ -99,6 +99,13 @@ class ZonaBuilder: else date.min, reverse=True, ) + posts = len(post_list) + for i, item in enumerate(post_list): + prev = post_list[i - 1] if i > 0 else None + next = post_list[i + 1] if i < posts - 2 else None + item.previous = prev + item.next = next + templater = Templater( config=self.config, template_dir=self.layout.templates, diff --git a/src/zona/data/content/static/style.css b/src/zona/data/content/static/style.css index d2cacf0..f02717e 100644 --- a/src/zona/data/content/static/style.css +++ b/src/zona/data/content/static/style.css @@ -31,6 +31,18 @@ header { text-transform: lowercase; } +.post-nav { + font-family: monospace; +} + +.post-nav .symbol { + color: var(--main-bullet-color); +} + +.post-nav a { + margin: 0 2px; +} + .site-logo { color: inherit; font-weight: bold; diff --git a/src/zona/data/templates/page.html b/src/zona/data/templates/page.html index fd3cdb4..0c22f8b 100644 --- a/src/zona/data/templates/page.html +++ b/src/zona/data/templates/page.html @@ -1,18 +1,12 @@ -{% extends "base.html" %} {% block content %} - -{% if metadata.show_title %} -{% include "title.html" %} -{% if metadata.date %} +{% extends "base.html" %} {% block content %} {% if metadata.show_title %} {% +include "title.html" %} {% if metadata.date %}
-{% endif %} +{% endif %} {% endif %} {% if is_post %} {% include "post_nav.html" %} {% endif +%}
-{% endif %}
{{ content | safe }}
{% endblock %} - - - diff --git a/src/zona/data/templates/post_nav.html b/src/zona/data/templates/post_nav.html new file mode 100644 index 0000000..324f110 --- /dev/null +++ b/src/zona/data/templates/post_nav.html @@ -0,0 +1,9 @@ +
+
+ <{% if previous %}prev{% endif %}{% if previous and next %}|{% endif %}{% if next %}next{% endif + %}> +
+
diff --git a/src/zona/metadata.py b/src/zona/metadata.py index 0cd6a8c..98b14cf 100644 --- a/src/zona/metadata.py +++ b/src/zona/metadata.py @@ -18,6 +18,8 @@ class Metadata: date: date description: str | None show_title: bool = True + show_date: bool = True + show_nav: bool = True style: str | None = "/static/style.css" header: bool = True footer: bool = True diff --git a/src/zona/models.py b/src/zona/models.py index 2e7721c..d009476 100644 --- a/src/zona/models.py +++ b/src/zona/models.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from dataclasses import dataclass from enum import Enum from pathlib import Path @@ -21,6 +23,8 @@ class Item: type: ItemType | None = None copy: bool = True post: bool = False + next: Item | None = None + previous: Item | None = None # @dataclass diff --git a/src/zona/templates.py b/src/zona/templates.py index 872762c..fe1e6dd 100644 --- a/src/zona/templates.py +++ b/src/zona/templates.py @@ -3,6 +3,7 @@ from typing import Literal from jinja2 import Environment, FileSystemLoader, select_autoescape +from zona import util from zona.config import ZonaConfig from zona.markdown import md_to_html from zona.models import Item @@ -76,5 +77,10 @@ class Templater: metadata=meta, header=header, footer=footer, + is_post=item.post, + next=util.normalize_url(item.next.url) if item.next else None, + previous=util.normalize_url(item.previous.url) + if item.previous + else None, post_list=self.post_list, ) From 1f2b7368156fb2ec6e2f2c2bb1523181e969013c Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Mon, 14 Jul 2025 21:20:50 -0400 Subject: [PATCH 25/26] feat: merge user templates with defaults --- README.md | 11 ++++++----- src/zona/builder.py | 24 ++++++++++++++++++------ src/zona/layout.py | 41 +++++++++++++++++++++++++++++++++++++++-- src/zona/templates.py | 5 ++++- src/zona/util.py | 36 +++++++++++++++++++++++++++++++++++- 5 files changed, 102 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d46a69b..bd7eb9b 100644 --- a/README.md +++ b/README.md @@ -172,8 +172,8 @@ public/ The **root** of the zona **project** _must_ contain the configuration file, `config.yml`, and a directory called `content`. A directory called `templates` -is optional, and prioritized if it exists. `public` is the built site output — -it's recommended to add this path to your `.gitignore`. +is optional, and merged with the defaults if it exists. `public` is the built +site output — it's recommended to add this path to your `.gitignore`. The `content` directory is the **root of the website**. Think of it as the **content root**. For example, suppose your website is hosted at `example.com`. @@ -191,9 +191,10 @@ site using the `post_list` template. ### Templates The `templates` directory may contain any `jinja2` template files. You may -modify the existing templates or create your own. To apply a certain template to -a page, set the `template` option in its [frontmatter](#frontmatter). The -following public variables are made available to the template engine: +modify the existing templates or create your own. Your templates are merged with +the packaged defaults. To apply a certain template to a page, set the `template` +option in its [frontmatter](#frontmatter). The following public variables are +made available to the template engine: | Name | Description | | ---------- | ------------------------------------------------------ | diff --git a/src/zona/builder.py b/src/zona/builder.py index c53701e..5c8af6b 100644 --- a/src/zona/builder.py +++ b/src/zona/builder.py @@ -30,6 +30,7 @@ class ZonaBuilder: self.config.build.include_drafts = True self.items: list[Item] = [] self.item_map: dict[Path, Item] = {} + self.fresh: bool = True def _discover(self): layout = self.layout @@ -48,7 +49,9 @@ class ZonaBuilder: destination=destination, url=str(destination.relative_to(layout.output)), ) - if path.name.endswith(".md") and not path.is_relative_to( + if path.name.endswith( + ".md" + ) and not path.is_relative_to( layout.root / "content" / "static" ): logger.debug(f"Parsing {path.name}.") @@ -69,11 +72,13 @@ class ZonaBuilder: item.copy = False name = destination.stem if name == "index": - item.destination = item.destination.with_suffix( - ".html" + item.destination = ( + item.destination.with_suffix(".html") ) else: - relative = path.relative_to(base).with_suffix("") + relative = path.relative_to(base).with_suffix( + "" + ) name = relative.stem item.destination = ( layout.output @@ -85,7 +90,9 @@ class ZonaBuilder: layout.output ) item.url = ( - "" if rel_url == Path(".") else rel_url.as_posix() + "" + if rel_url == Path(".") + else rel_url.as_posix() ) items.append(item) self.items = items @@ -118,7 +125,9 @@ class ZonaBuilder: # write code highlighting stylesheet if self.config.markdown.syntax_highlighting.enabled: pygments_style = zmd.get_style_defs(self.config) - pygments_path = self.layout.output / "static" / "pygments.css" + pygments_path = ( + self.layout.output / "static" / "pygments.css" + ) util.ensure_parents(pygments_path) pygments_path.write_text(pygments_style) for item in self.item_map.values(): @@ -159,7 +168,10 @@ class ZonaBuilder: child.unlink() elif child.is_dir(): shutil.rmtree(child) + if not self.fresh: + self.layout = self.layout.refresh() logger.debug("Discovering...") self._discover() logger.debug("Building...") self._build() + self.fresh = False diff --git a/src/zona/layout.py b/src/zona/layout.py index 3526c4e..3d8de3d 100644 --- a/src/zona/layout.py +++ b/src/zona/layout.py @@ -16,6 +16,22 @@ class Layout: content: Path templates: Path output: Path + shared_templates: util.TempDir | None + _validate: bool + + def refresh(self): + logger.debug("Refreshing layout...") + if ( + self.shared_templates + and not self.shared_templates.removed + ): + logger.debug("Removing stale templates tempdir...") + self.shared_templates.remove() + return self.__class__.from_input( + root=self.root, + output=self.output, + validate=self._validate, + ) @classmethod def from_input( @@ -31,6 +47,8 @@ class Layout: output=(root / "public").resolve() if not output else output, + shared_templates=None, + _validate=validate, ) if validate: logger.debug("Validating site layout...") @@ -39,10 +57,29 @@ class Layout: raise FileNotFoundError( "Missing required content directory!" ) - if not layout.templates.is_dir(): + internal_templates = util.get_resource_dir("templates") + user_templates = layout.templates + if not user_templates.is_dir() or util.is_empty( + user_templates + ): logger.debug("Using default template directory.") # use the included defaults - layout.templates = util.get_resource_dir("templates") + layout.templates = internal_templates + else: + seen: set[str] = set() + temp = util.TempDir() + logger.debug( + f"Creating shared template directory at {temp}" + ) + for f in user_templates.iterdir(): + if f.is_file(): + util.copy_static_file(f, temp.path) + seen.add(f.name) + for f in internal_templates.iterdir(): + if f.is_file() and f.name not in seen: + util.copy_static_file(f, temp.path) + layout.shared_templates = temp + layout.templates = temp.path return layout diff --git a/src/zona/templates.py b/src/zona/templates.py index fe1e6dd..d5e0f22 100644 --- a/src/zona/templates.py +++ b/src/zona/templates.py @@ -36,6 +36,7 @@ class Templater: template_dir: Path, post_list: list[Item], ): + # build temporary template dir self.env: Environment = Environment( loader=FileSystemLoader(template_dir), autoescape=select_autoescape(["html", "xml"]), @@ -78,7 +79,9 @@ class Templater: header=header, footer=footer, is_post=item.post, - next=util.normalize_url(item.next.url) if item.next else None, + next=util.normalize_url(item.next.url) + if item.next + else None, previous=util.normalize_url(item.previous.url) if item.previous else None, diff --git a/src/zona/util.py b/src/zona/util.py index 9ccc2c6..5bf6f53 100644 --- a/src/zona/util.py +++ b/src/zona/util.py @@ -1,11 +1,36 @@ import fnmatch import re +import shutil import string +import tempfile +import weakref from importlib import resources from importlib.resources.abc import Traversable from pathlib import Path from shutil import copy2 -from typing import NamedTuple +from typing import Any, NamedTuple, override + + +class TempDir: + """Temporary directory that cleans up when it's garbage collected.""" + + def __init__(self): + self._tempdir: str = tempfile.mkdtemp() + self.path: Path = Path(self._tempdir) + self._finalizer: weakref.finalize[Any, Any] = ( + weakref.finalize(self, shutil.rmtree, self._tempdir) + ) + + def remove(self): + self._finalizer() + + @property + def removed(self): + return not self._finalizer.alive + + @override + def __repr__(self) -> str: + return f"" class ZonaResource(NamedTuple): @@ -65,6 +90,15 @@ def copy_static_file(src: Path, dst: Path): copy2(src, dst) +def is_empty(path: Path) -> bool: + """If given a file, check if it has any non-whitespace content. + If given a directory, check if it has any children.""" + if path.is_file(): + return path.read_text().strip() == "" + else: + return not any(path.iterdir()) + + def filename_to_title(path: Path) -> str: name = path.stem words = name.replace("-", " ").replace("_", " ") From 70887156fb99b468efd50eb82452301f57dbea0f Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sat, 12 Jul 2025 01:06:31 -0400 Subject: [PATCH 26/26] wip: generate RSS feed --- pyproject.toml | 3 ++- src/zona/config.py | 4 ++++ src/zona/feed.py | 1 + uv.lock | 52 ++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 59 insertions(+), 1 deletion(-) create mode 100644 src/zona/feed.py diff --git a/pyproject.toml b/pyproject.toml index 2a2e6b4..ae54eac 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -11,6 +11,7 @@ authors = [ requires-python = ">=3.12" dependencies = [ "dacite>=1.9.2", + "feedgen>=1.0.0", "jinja2>=3.1.6", "l2m4m>=1.0.4", "markdown>=3.8.2", @@ -57,7 +58,7 @@ reportUnusedCallResult = false reportCallInDefaultInitializer = false enableTypeIgnoreComments = true reportIgnoreCommentWithoutRule = false -allowedUntypedLibraries = ["frontmatter", "pygments", "pymdownx", "l2m4m"] +allowedUntypedLibraries = ["frontmatter", "pygments", "pymdownx", "l2m4m", "feedgen"] [tool.ruff] line-length = 70 diff --git a/src/zona/config.py b/src/zona/config.py index 2a50fd4..752c7f3 100644 --- a/src/zona/config.py +++ b/src/zona/config.py @@ -75,6 +75,10 @@ IGNORELIST = [".marksman.toml"] @dataclass class ZonaConfig: base_url: str = "/" + link: str = "example.com" + title: str = "Zona Website" + description: str = "My zona website." + language: str = "en" # dictionary where key is name, value is url sitemap: SitemapConfig = field( default_factory=lambda: {"Home": "/"} diff --git a/src/zona/feed.py b/src/zona/feed.py new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/src/zona/feed.py @@ -0,0 +1 @@ + diff --git a/uv.lock b/uv.lock index af06654..6835dac 100644 --- a/uv.lock +++ b/uv.lock @@ -44,6 +44,16 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/94/35/386550fd60316d1e37eccdda609b074113298f23cef5bddb2049823fe666/dacite-1.9.2-py3-none-any.whl", hash = "sha256:053f7c3f5128ca2e9aceb66892b1a3c8936d02c686e707bee96e19deef4bc4a0", size = 16600, upload-time = "2025-02-05T09:27:24.345Z" }, ] +[[package]] +name = "feedgen" +version = "1.0.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "lxml" }, + { name = "python-dateutil" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/6b/59/be0a6f852b5dfbf19e6c8e962c8f41407697f9f52a7902250ed98683ae89/feedgen-1.0.0.tar.gz", hash = "sha256:d9bd51c3b5e956a2a52998c3708c4d2c729f2fcc311188e1e5d3b9726393546a", size = 258496, upload-time = "2023-12-25T18:04:08.421Z" } + [[package]] name = "iniconfig" version = "2.1.0" @@ -87,6 +97,46 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/1e/fd/aba08bb9e527168efad57985d7db9a853eb2384b1efa5ca5f3a3794c9cef/latex2mathml-3.78.0-py3-none-any.whl", hash = "sha256:1aeca3dc027b3006ad7b301b7f4a15ffbb4c1451e3dc8c3389e97b37b497e1d6", size = 73673, upload-time = "2025-05-03T16:51:51.991Z" }, ] +[[package]] +name = "lxml" +version = "6.0.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/c5/ed/60eb6fa2923602fba988d9ca7c5cdbd7cf25faa795162ed538b527a35411/lxml-6.0.0.tar.gz", hash = "sha256:032e65120339d44cdc3efc326c9f660f5f7205f3a535c1fdbf898b29ea01fb72", size = 4096938, upload-time = "2025-06-26T16:28:19.373Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/89/c3/d01d735c298d7e0ddcedf6f028bf556577e5ab4f4da45175ecd909c79378/lxml-6.0.0-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:78718d8454a6e928470d511bf8ac93f469283a45c354995f7d19e77292f26108", size = 8429515, upload-time = "2025-06-26T16:26:06.776Z" }, + { url = "https://files.pythonhosted.org/packages/06/37/0e3eae3043d366b73da55a86274a590bae76dc45aa004b7042e6f97803b1/lxml-6.0.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:84ef591495ffd3f9dcabffd6391db7bb70d7230b5c35ef5148354a134f56f2be", size = 4601387, upload-time = "2025-06-26T16:26:09.511Z" }, + { url = "https://files.pythonhosted.org/packages/a3/28/e1a9a881e6d6e29dda13d633885d13acb0058f65e95da67841c8dd02b4a8/lxml-6.0.0-cp312-cp312-manylinux2010_i686.manylinux2014_i686.manylinux_2_12_i686.manylinux_2_17_i686.whl", hash = "sha256:2930aa001a3776c3e2601cb8e0a15d21b8270528d89cc308be4843ade546b9ab", size = 5228928, upload-time = "2025-06-26T16:26:12.337Z" }, + { url = "https://files.pythonhosted.org/packages/9a/55/2cb24ea48aa30c99f805921c1c7860c1f45c0e811e44ee4e6a155668de06/lxml-6.0.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:219e0431ea8006e15005767f0351e3f7f9143e793e58519dc97fe9e07fae5563", size = 4952289, upload-time = "2025-06-28T18:47:25.602Z" }, + { url = "https://files.pythonhosted.org/packages/31/c0/b25d9528df296b9a3306ba21ff982fc5b698c45ab78b94d18c2d6ae71fd9/lxml-6.0.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:bd5913b4972681ffc9718bc2d4c53cde39ef81415e1671ff93e9aa30b46595e7", size = 5111310, upload-time = "2025-06-28T18:47:28.136Z" }, + { url = "https://files.pythonhosted.org/packages/e9/af/681a8b3e4f668bea6e6514cbcb297beb6de2b641e70f09d3d78655f4f44c/lxml-6.0.0-cp312-cp312-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:390240baeb9f415a82eefc2e13285016f9c8b5ad71ec80574ae8fa9605093cd7", size = 5025457, upload-time = "2025-06-26T16:26:15.068Z" }, + { url = "https://files.pythonhosted.org/packages/99/b6/3a7971aa05b7be7dfebc7ab57262ec527775c2c3c5b2f43675cac0458cad/lxml-6.0.0-cp312-cp312-manylinux_2_27_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:d6e200909a119626744dd81bae409fc44134389e03fbf1d68ed2a55a2fb10991", size = 5657016, upload-time = "2025-07-03T19:19:06.008Z" }, + { url = "https://files.pythonhosted.org/packages/69/f8/693b1a10a891197143c0673fcce5b75fc69132afa81a36e4568c12c8faba/lxml-6.0.0-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:ca50bd612438258a91b5b3788c6621c1f05c8c478e7951899f492be42defc0da", size = 5257565, upload-time = "2025-06-26T16:26:17.906Z" }, + { url = "https://files.pythonhosted.org/packages/a8/96/e08ff98f2c6426c98c8964513c5dab8d6eb81dadcd0af6f0c538ada78d33/lxml-6.0.0-cp312-cp312-manylinux_2_31_armv7l.whl", hash = "sha256:c24b8efd9c0f62bad0439283c2c795ef916c5a6b75f03c17799775c7ae3c0c9e", size = 4713390, upload-time = "2025-06-26T16:26:20.292Z" }, + { url = "https://files.pythonhosted.org/packages/a8/83/6184aba6cc94d7413959f6f8f54807dc318fdcd4985c347fe3ea6937f772/lxml-6.0.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:afd27d8629ae94c5d863e32ab0e1d5590371d296b87dae0a751fb22bf3685741", size = 5066103, upload-time = "2025-06-26T16:26:22.765Z" }, + { url = "https://files.pythonhosted.org/packages/ee/01/8bf1f4035852d0ff2e36a4d9aacdbcc57e93a6cd35a54e05fa984cdf73ab/lxml-6.0.0-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:54c4855eabd9fc29707d30141be99e5cd1102e7d2258d2892314cf4c110726c3", size = 4791428, upload-time = "2025-06-26T16:26:26.461Z" }, + { url = "https://files.pythonhosted.org/packages/29/31/c0267d03b16954a85ed6b065116b621d37f559553d9339c7dcc4943a76f1/lxml-6.0.0-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:c907516d49f77f6cd8ead1322198bdfd902003c3c330c77a1c5f3cc32a0e4d16", size = 5678523, upload-time = "2025-07-03T19:19:09.837Z" }, + { url = "https://files.pythonhosted.org/packages/5c/f7/5495829a864bc5f8b0798d2b52a807c89966523140f3d6fa3a58ab6720ea/lxml-6.0.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:36531f81c8214e293097cd2b7873f178997dae33d3667caaae8bdfb9666b76c0", size = 5281290, upload-time = "2025-06-26T16:26:29.406Z" }, + { url = "https://files.pythonhosted.org/packages/79/56/6b8edb79d9ed294ccc4e881f4db1023af56ba451909b9ce79f2a2cd7c532/lxml-6.0.0-cp312-cp312-win32.whl", hash = "sha256:690b20e3388a7ec98e899fd54c924e50ba6693874aa65ef9cb53de7f7de9d64a", size = 3613495, upload-time = "2025-06-26T16:26:31.588Z" }, + { url = "https://files.pythonhosted.org/packages/0b/1e/cc32034b40ad6af80b6fd9b66301fc0f180f300002e5c3eb5a6110a93317/lxml-6.0.0-cp312-cp312-win_amd64.whl", hash = "sha256:310b719b695b3dd442cdfbbe64936b2f2e231bb91d998e99e6f0daf991a3eba3", size = 4014711, upload-time = "2025-06-26T16:26:33.723Z" }, + { url = "https://files.pythonhosted.org/packages/55/10/dc8e5290ae4c94bdc1a4c55865be7e1f31dfd857a88b21cbba68b5fea61b/lxml-6.0.0-cp312-cp312-win_arm64.whl", hash = "sha256:8cb26f51c82d77483cdcd2b4a53cda55bbee29b3c2f3ddeb47182a2a9064e4eb", size = 3674431, upload-time = "2025-06-26T16:26:35.959Z" }, + { url = "https://files.pythonhosted.org/packages/79/21/6e7c060822a3c954ff085e5e1b94b4a25757c06529eac91e550f3f5cd8b8/lxml-6.0.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:6da7cd4f405fd7db56e51e96bff0865b9853ae70df0e6720624049da76bde2da", size = 8414372, upload-time = "2025-06-26T16:26:39.079Z" }, + { url = "https://files.pythonhosted.org/packages/a4/f6/051b1607a459db670fc3a244fa4f06f101a8adf86cda263d1a56b3a4f9d5/lxml-6.0.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:b34339898bb556a2351a1830f88f751679f343eabf9cf05841c95b165152c9e7", size = 4593940, upload-time = "2025-06-26T16:26:41.891Z" }, + { url = "https://files.pythonhosted.org/packages/8e/74/dd595d92a40bda3c687d70d4487b2c7eff93fd63b568acd64fedd2ba00fe/lxml-6.0.0-cp313-cp313-manylinux2010_i686.manylinux2014_i686.manylinux_2_12_i686.manylinux_2_17_i686.whl", hash = "sha256:51a5e4c61a4541bd1cd3ba74766d0c9b6c12d6a1a4964ef60026832aac8e79b3", size = 5214329, upload-time = "2025-06-26T16:26:44.669Z" }, + { url = "https://files.pythonhosted.org/packages/52/46/3572761efc1bd45fcafb44a63b3b0feeb5b3f0066886821e94b0254f9253/lxml-6.0.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:d18a25b19ca7307045581b18b3ec9ead2b1db5ccd8719c291f0cd0a5cec6cb81", size = 4947559, upload-time = "2025-06-28T18:47:31.091Z" }, + { url = "https://files.pythonhosted.org/packages/94/8a/5e40de920e67c4f2eef9151097deb9b52d86c95762d8ee238134aff2125d/lxml-6.0.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:d4f0c66df4386b75d2ab1e20a489f30dc7fd9a06a896d64980541506086be1f1", size = 5102143, upload-time = "2025-06-28T18:47:33.612Z" }, + { url = "https://files.pythonhosted.org/packages/7c/4b/20555bdd75d57945bdabfbc45fdb1a36a1a0ff9eae4653e951b2b79c9209/lxml-6.0.0-cp313-cp313-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:9f4b481b6cc3a897adb4279216695150bbe7a44c03daba3c894f49d2037e0a24", size = 5021931, upload-time = "2025-06-26T16:26:47.503Z" }, + { url = "https://files.pythonhosted.org/packages/b6/6e/cf03b412f3763d4ca23b25e70c96a74cfece64cec3addf1c4ec639586b13/lxml-6.0.0-cp313-cp313-manylinux_2_27_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:8a78d6c9168f5bcb20971bf3329c2b83078611fbe1f807baadc64afc70523b3a", size = 5645469, upload-time = "2025-07-03T19:19:13.32Z" }, + { url = "https://files.pythonhosted.org/packages/d4/dd/39c8507c16db6031f8c1ddf70ed95dbb0a6d466a40002a3522c128aba472/lxml-6.0.0-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:2ae06fbab4f1bb7db4f7c8ca9897dc8db4447d1a2b9bee78474ad403437bcc29", size = 5247467, upload-time = "2025-06-26T16:26:49.998Z" }, + { url = "https://files.pythonhosted.org/packages/4d/56/732d49def0631ad633844cfb2664563c830173a98d5efd9b172e89a4800d/lxml-6.0.0-cp313-cp313-manylinux_2_31_armv7l.whl", hash = "sha256:1fa377b827ca2023244a06554c6e7dc6828a10aaf74ca41965c5d8a4925aebb4", size = 4720601, upload-time = "2025-06-26T16:26:52.564Z" }, + { url = "https://files.pythonhosted.org/packages/8f/7f/6b956fab95fa73462bca25d1ea7fc8274ddf68fb8e60b78d56c03b65278e/lxml-6.0.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:1676b56d48048a62ef77a250428d1f31f610763636e0784ba67a9740823988ca", size = 5060227, upload-time = "2025-06-26T16:26:55.054Z" }, + { url = "https://files.pythonhosted.org/packages/97/06/e851ac2924447e8b15a294855caf3d543424364a143c001014d22c8ca94c/lxml-6.0.0-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:0e32698462aacc5c1cf6bdfebc9c781821b7e74c79f13e5ffc8bfe27c42b1abf", size = 4790637, upload-time = "2025-06-26T16:26:57.384Z" }, + { url = "https://files.pythonhosted.org/packages/06/d4/fd216f3cd6625022c25b336c7570d11f4a43adbaf0a56106d3d496f727a7/lxml-6.0.0-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:4d6036c3a296707357efb375cfc24bb64cd955b9ec731abf11ebb1e40063949f", size = 5662049, upload-time = "2025-07-03T19:19:16.409Z" }, + { url = "https://files.pythonhosted.org/packages/52/03/0e764ce00b95e008d76b99d432f1807f3574fb2945b496a17807a1645dbd/lxml-6.0.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:7488a43033c958637b1a08cddc9188eb06d3ad36582cebc7d4815980b47e27ef", size = 5272430, upload-time = "2025-06-26T16:27:00.031Z" }, + { url = "https://files.pythonhosted.org/packages/5f/01/d48cc141bc47bc1644d20fe97bbd5e8afb30415ec94f146f2f76d0d9d098/lxml-6.0.0-cp313-cp313-win32.whl", hash = "sha256:5fcd7d3b1d8ecb91445bd71b9c88bdbeae528fefee4f379895becfc72298d181", size = 3612896, upload-time = "2025-06-26T16:27:04.251Z" }, + { url = "https://files.pythonhosted.org/packages/f4/87/6456b9541d186ee7d4cb53bf1b9a0d7f3b1068532676940fdd594ac90865/lxml-6.0.0-cp313-cp313-win_amd64.whl", hash = "sha256:2f34687222b78fff795feeb799a7d44eca2477c3d9d3a46ce17d51a4f383e32e", size = 4013132, upload-time = "2025-06-26T16:27:06.415Z" }, + { url = "https://files.pythonhosted.org/packages/b7/42/85b3aa8f06ca0d24962f8100f001828e1f1f1a38c954c16e71154ed7d53a/lxml-6.0.0-cp313-cp313-win_arm64.whl", hash = "sha256:21db1ec5525780fd07251636eb5f7acb84003e9382c72c18c542a87c416ade03", size = 3672642, upload-time = "2025-06-26T16:27:09.888Z" }, +] + [[package]] name = "markdown" version = "3.8.2" @@ -463,6 +513,7 @@ version = "1.0.0" source = { editable = "." } dependencies = [ { name = "dacite" }, + { name = "feedgen" }, { name = "jinja2" }, { name = "l2m4m" }, { name = "markdown" }, @@ -489,6 +540,7 @@ dev = [ [package.metadata] requires-dist = [ { name = "dacite", specifier = ">=1.9.2" }, + { name = "feedgen", specifier = ">=1.0.0" }, { name = "jinja2", specifier = ">=3.1.6" }, { name = "l2m4m", specifier = ">=1.0.4" }, { name = "markdown", specifier = ">=3.8.2" },