mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
tvl-depot/web/blog/fragments.nix

96 lines
3 KiB
Nix
Raw Normal View History

feat(web/blog): Add Nix-based static blog generator This introduces a derivation which builds an instance of nginx statically serving my blog posts, though as of now no indexes are being generated and no XML feed is available. This is just the initial draft of this setup and not yet what shall be yielded in the end.
2020-02-08 14:33:13 +01:00
# This file defines various fragments of the blog, such as the header
# and footer, as functions that receive arguments to be templated into
# them.
#
# An entire post is rendered by `renderPost`, which assembles the
# fragments together in a runCommand execution.
refactor: Move nixpkgs attribute to `third_party.nixpkgs` Please read b/108 to make sense of this. This gets rid of the explicit list of exposed packages from nixpkgs, and instead makes the entire package set available at `third_party.nixpkgs`. To accommodate this, a LOT of things have to be very slightly shuffled around. Some of this was done in already submitted CLs, but this change is unfortunately still quite noisy. Pay extra attention to: * overlay-like functionality that was partially moved to actual overlays (partially as in, the minimum required to get a green build) * modified uses of the package set path, esp. in NixOS systems Special notes: * xanthous has been disabled in CI because of issues with the Haskell overlay * //third_party/nix has been disabled because of other unclear dependency issues Both of these will be tackled in a followup CL. Change-Id: I2f9c60a4d275fdb5209264be0addfd7e06c53118 Reviewed-on: https://cl.tvl.fyi/c/depot/+/2910 Reviewed-by: glittershark <grfn@gws.fyi> Reviewed-by: sterni <sternenseemann@systemli.org> Tested-by: BuildkiteCI
2021-04-10 18:05:16 +02:00
{ depot, lib, pkgs, ... }:
feat(web/blog): Add Nix-based static blog generator This introduces a derivation which builds an instance of nginx statically serving my blog posts, though as of now no indexes are being generated and no XML feed is available. This is just the initial draft of this setup and not yet what shall be yielded in the end.
2020-02-08 14:33:13 +01:00
let
refactor: Replace some uses of builtins.toFile with pkgs.writeText I'm looking at removing some of these because they can cause unnecessary build steps during CI pipeline generation. Change-Id: I84742968918090c050d2eedab8a1b42692632a42 Reviewed-on: https://cl.tvl.fyi/c/depot/+/2655 Reviewed-by: sterni <sternenseemann@systemli.org> Tested-by: BuildkiteCI
2021-03-25 19:14:48 +01:00
inherit (builtins) filter map hasAttr replaceStrings;
refactor: Move nixpkgs attribute to `third_party.nixpkgs` Please read b/108 to make sense of this. This gets rid of the explicit list of exposed packages from nixpkgs, and instead makes the entire package set available at `third_party.nixpkgs`. To accommodate this, a LOT of things have to be very slightly shuffled around. Some of this was done in already submitted CLs, but this change is unfortunately still quite noisy. Pay extra attention to: * overlay-like functionality that was partially moved to actual overlays (partially as in, the minimum required to get a green build) * modified uses of the package set path, esp. in NixOS systems Special notes: * xanthous has been disabled in CI because of issues with the Haskell overlay * //third_party/nix has been disabled because of other unclear dependency issues Both of these will be tackled in a followup CL. Change-Id: I2f9c60a4d275fdb5209264be0addfd7e06c53118 Reviewed-on: https://cl.tvl.fyi/c/depot/+/2910 Reviewed-by: glittershark <grfn@gws.fyi> Reviewed-by: sterni <sternenseemann@systemli.org> Tested-by: BuildkiteCI
2021-04-10 18:05:16 +02:00
inherit (pkgs) runCommandNoCC writeText;
chore(nix/renderMarkdown): Move out of //users/tazjin Change-Id: Ia5e873420b57436abead8e02cef3e5b7149de123 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3731 Tested-by: BuildkiteCI Reviewed-by: sterni <sternenseemann@systemli.org>
2021-10-16 16:30:41 +02:00
inherit (depot.nix) renderMarkdown;
feat(web/blog): Add Nix-based static blog generator This introduces a derivation which builds an instance of nginx statically serving my blog posts, though as of now no indexes are being generated and no XML feed is available. This is just the initial draft of this setup and not yet what shall be yielded in the end.
2020-02-08 14:33:13 +01:00
chore(web): Correct URLs for assets & feeds on TVL blog Change-Id: I8720d49f8f3f4010f57a53e763a4f246bf4eb3d8
2021-11-30 10:51:30 +01:00
staticUrl = "https://static.tvl.fyi/${depot.web.static.drvHash}";
feat(web/blog): Add support for draft & unlisted posts Posts with either `draft = true;` or `listed = false;` will no longer be included in index generation and will have a warning callout inserted at the top of the page urging people not to share the links to them.
2020-02-09 22:44:48 +01:00
# Generate a post list for all listed, non-draft posts.
isDraft = post: (hasAttr "draft" post) && post.draft;
isUnlisted = post: (hasAttr "listed" post) && !post.listed;
feat(web/blog): Add Nix-based static blog generator This introduces a derivation which builds an instance of nginx statically serving my blog posts, though as of now no indexes are being generated and no XML feed is available. This is just the initial draft of this setup and not yet what shall be yielded in the end.
2020-02-08 14:33:13 +01:00
escape = replaceStrings [ "<" ">" "&" "'" ] [ "&lt;" "&gt;" "&amp;" "&#39;" ];
refactor(web/blog): Configurable blog name and footer Required for actually using this generically for the TVL blog. Change-Id: I92d8d10341f9ab4f92c90f7976be261b3255a0f0 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3768 Tested-by: BuildkiteCI Reviewed-by: sterni <sternenseemann@systemli.org>
2021-11-02 14:34:20 +01:00
header = name: title: ''
feat(web/blog): Add Nix-based static blog generator This introduces a derivation which builds an instance of nginx statically serving my blog posts, though as of now no indexes are being generated and no XML feed is available. This is just the initial draft of this setup and not yet what shall be yielded in the end.
2020-02-08 14:33:13 +01:00
<!DOCTYPE html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
refactor(web/blog): Configurable blog name and footer Required for actually using this generically for the TVL blog. Change-Id: I92d8d10341f9ab4f92c90f7976be261b3255a0f0 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3768 Tested-by: BuildkiteCI Reviewed-by: sterni <sternenseemann@systemli.org>
2021-11-02 14:34:20 +01:00
<meta name="description" content="${escape name}">
chore(web): Correct URLs for assets & feeds on TVL blog Change-Id: I8720d49f8f3f4010f57a53e763a4f246bf4eb3d8
2021-11-30 10:51:30 +01:00
<link rel="stylesheet" type="text/css" href="${staticUrl}/tvl.css" media="all">
feat(web): Add a favicon to homepage & blog
2020-02-09 01:43:00 +01:00
<link rel="icon" type="image/webp" href="/static/favicon.webp">
chore(web): Correct URLs for assets & feeds on TVL blog Change-Id: I8720d49f8f3f4010f57a53e763a4f246bf4eb3d8
2021-11-30 10:51:30 +01:00
<link rel="alternate" type="application/atom+xml" title="Atom Feed" href="https://tvl.fyi/feed.atom">
refactor(web/blog): Configurable blog name and footer Required for actually using this generically for the TVL blog. Change-Id: I92d8d10341f9ab4f92c90f7976be261b3255a0f0 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3768 Tested-by: BuildkiteCI Reviewed-by: sterni <sternenseemann@systemli.org>
2021-11-02 14:34:20 +01:00
<title>${escape name}: ${escape title}</title>
feat(web/blog): Add Nix-based static blog generator This introduces a derivation which builds an instance of nginx statically serving my blog posts, though as of now no indexes are being generated and no XML feed is available. This is just the initial draft of this setup and not yet what shall be yielded in the end.
2020-02-08 14:33:13 +01:00
</head>
refactor(web): Serve static assets to //web/homepage Shuffles around the nginx locations that are served to ensure that all static content will be served from tazj.in/static (including for the blog).
2020-02-09 01:01:07 +01:00
<body class="light">
feat(web/blog): Add Nix-based static blog generator This introduces a derivation which builds an instance of nginx statically serving my blog posts, though as of now no indexes are being generated and no XML feed is available. This is just the initial draft of this setup and not yet what shall be yielded in the end.
2020-02-08 14:33:13 +01:00
<header>
refactor(web/blog): Configurable blog name and footer Required for actually using this generically for the TVL blog. Change-Id: I92d8d10341f9ab4f92c90f7976be261b3255a0f0 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3768 Tested-by: BuildkiteCI Reviewed-by: sterni <sternenseemann@systemli.org>
2021-11-02 14:34:20 +01:00
<h1><a class="blog-title" href="/">${escape name}</a> </h1>
feat(web/blog): Add Nix-based static blog generator This introduces a derivation which builds an instance of nginx statically serving my blog posts, though as of now no indexes are being generated and no XML feed is available. This is just the initial draft of this setup and not yet what shall be yielded in the end.
2020-02-08 14:33:13 +01:00
<hr>
</header>
'';
fix(web/blog): Correctly wrap footer content Name clash went undetected because I called this variable the same thing, oops. Change-Id: Iafa508f26887302b1c256088c50c68cd0ed7eea2 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3771 Tested-by: BuildkiteCI Reviewed-by: sterni <sternenseemann@systemli.org>
2021-11-04 16:23:47 +01:00
fullFooter = content: ''
feat(web/blog): Add Nix-based static blog generator This introduces a derivation which builds an instance of nginx statically serving my blog posts, though as of now no indexes are being generated and no XML feed is available. This is just the initial draft of this setup and not yet what shall be yielded in the end.
2020-02-08 14:33:13 +01:00
<hr>
<footer>
refactor(web/blog): Configurable blog name and footer Required for actually using this generically for the TVL blog. Change-Id: I92d8d10341f9ab4f92c90f7976be261b3255a0f0 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3768 Tested-by: BuildkiteCI Reviewed-by: sterni <sternenseemann@systemli.org>
2021-11-02 14:34:20 +01:00
${content}
feat(web/blog): Add Nix-based static blog generator This introduces a derivation which builds an instance of nginx statically serving my blog posts, though as of now no indexes are being generated and no XML feed is available. This is just the initial draft of this setup and not yet what shall be yielded in the end.
2020-02-08 14:33:13 +01:00
</footer>
</body>
'';
refactor: Replace some uses of builtins.toFile with pkgs.writeText I'm looking at removing some of these because they can cause unnecessary build steps during CI pipeline generation. Change-Id: I84742968918090c050d2eedab8a1b42692632a42 Reviewed-on: https://cl.tvl.fyi/c/depot/+/2655 Reviewed-by: sterni <sternenseemann@systemli.org> Tested-by: BuildkiteCI
2021-03-25 19:14:48 +01:00
draftWarning = writeText "draft.html" ''
feat(web/blog): Add support for draft & unlisted posts Posts with either `draft = true;` or `listed = false;` will no longer be included in index generation and will have a warning callout inserted at the top of the page urging people not to share the links to them.
2020-02-09 22:44:48 +01:00
<p class="cheddar-callout cheddar-warning">
<b>Note:</b> This post is a <b>draft</b>! Please do not share
refactor(web/blog): Configurable blog name and footer Required for actually using this generically for the TVL blog. Change-Id: I92d8d10341f9ab4f92c90f7976be261b3255a0f0 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3768 Tested-by: BuildkiteCI Reviewed-by: sterni <sternenseemann@systemli.org>
2021-11-02 14:34:20 +01:00
the link to it without asking first.
feat(web/blog): Add support for draft & unlisted posts Posts with either `draft = true;` or `listed = false;` will no longer be included in index generation and will have a warning callout inserted at the top of the page urging people not to share the links to them.
2020-02-09 22:44:48 +01:00
</p>
<hr>
'';
refactor: Replace some uses of builtins.toFile with pkgs.writeText I'm looking at removing some of these because they can cause unnecessary build steps during CI pipeline generation. Change-Id: I84742968918090c050d2eedab8a1b42692632a42 Reviewed-on: https://cl.tvl.fyi/c/depot/+/2655 Reviewed-by: sterni <sternenseemann@systemli.org> Tested-by: BuildkiteCI
2021-03-25 19:14:48 +01:00
unlistedWarning = writeText "unlisted.html" ''
feat(web/blog): Add support for draft & unlisted posts Posts with either `draft = true;` or `listed = false;` will no longer be included in index generation and will have a warning callout inserted at the top of the page urging people not to share the links to them.
2020-02-09 22:44:48 +01:00
<p class="cheddar-callout cheddar-warning">
<b>Note:</b> This post is <b>unlisted</b>! Please do not share
refactor(web/blog): Configurable blog name and footer Required for actually using this generically for the TVL blog. Change-Id: I92d8d10341f9ab4f92c90f7976be261b3255a0f0 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3768 Tested-by: BuildkiteCI Reviewed-by: sterni <sternenseemann@systemli.org>
2021-11-02 14:34:20 +01:00
the link to it without asking first.
feat(web/blog): Add support for draft & unlisted posts Posts with either `draft = true;` or `listed = false;` will no longer be included in index generation and will have a warning callout inserted at the top of the page urging people not to share the links to them.
2020-02-09 22:44:48 +01:00
</p>
<hr>
'';
fix(web/blog): make base URL configurable for atom feeds This was previously hardcoded to tazj.in, which is not going to work of course. Instead it now takes the blog config which has a new baseUrl parameter. For ease of use, the configs of my and the TVL blog have been moved into a location that is accessible in the tree for reuse. Change-Id: I94e71aaa7859db4380eb7013740a17f6b6a02620 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3777 Tested-by: BuildkiteCI Reviewed-by: tazjin <mail@tazj.in>
2021-11-05 14:19:06 +01:00
renderPost = { name, footer, ... }: post: runCommandNoCC "${post.key}.html" {} ''
refactor(web/blog): Configurable blog name and footer Required for actually using this generically for the TVL blog. Change-Id: I92d8d10341f9ab4f92c90f7976be261b3255a0f0 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3768 Tested-by: BuildkiteCI Reviewed-by: sterni <sternenseemann@systemli.org>
2021-11-02 14:34:20 +01:00
cat ${writeText "header.html" (header name post.title)} > $out
feat(web/blog): Add Nix-based static blog generator This introduces a derivation which builds an instance of nginx statically serving my blog posts, though as of now no indexes are being generated and no XML feed is available. This is just the initial draft of this setup and not yet what shall be yielded in the end.
2020-02-08 14:33:13 +01:00
refactor(web/blog): Use timestamps for dates instead of strings This lets me easily create an ordered list of entries if the homepage is designed to list both blog posts and other content.
2020-02-08 14:47:47 +01:00
# Write the post title & date
feat(web/blog): Add Nix-based static blog generator This introduces a derivation which builds an instance of nginx statically serving my blog posts, though as of now no indexes are being generated and no XML feed is available. This is just the initial draft of this setup and not yet what shall be yielded in the end.
2020-02-08 14:33:13 +01:00
echo '<article><h2 class="inline">${escape post.title}</h2>' >> $out
refactor(web/blog): Use timestamps for dates instead of strings This lets me easily create an ordered list of entries if the homepage is designed to list both blog posts and other content.
2020-02-08 14:47:47 +01:00
echo '<aside class="date">' >> $out
date --date="@${toString post.date}" '+%Y-%m-%d' >> $out
feat(tazjin/blog): Add distinction between published & updated times Fixes a long-standing todo by adding an additional field for the time at which a post was updated, and handling this in both site generation (to note the update date after the publish date) and in Atom feed generation (by populating both the updated and published fields). Change-Id: If80db43459b2a0c77eea4dde7255651b5d6cd64b Reviewed-on: https://cl.tvl.fyi/c/depot/+/2766 Reviewed-by: tazjin <mail@tazj.in> Tested-by: BuildkiteCI
2021-04-02 15:35:35 +02:00
${
if post ? updated
then ''date --date="@${toString post.updated}" '+ (updated %Y-%m-%d)' >> $out''
else ""
}
refactor(web/blog): Use timestamps for dates instead of strings This lets me easily create an ordered list of entries if the homepage is designed to list both blog posts and other content.
2020-02-08 14:47:47 +01:00
echo '</aside>' >> $out
feat(web/blog): Add support for draft & unlisted posts Posts with either `draft = true;` or `listed = false;` will no longer be included in index generation and will have a warning callout inserted at the top of the page urging people not to share the links to them.
2020-02-09 22:44:48 +01:00
${
# Add a warning to draft/unlisted posts to make it clear that
# people should not share the post.
if (isDraft post) then "cat ${draftWarning} >> $out"
else if (isUnlisted post) then "cat ${unlistedWarning} >> $out"
else "# Your ads could be here?"
}
refactor(web/blog): Use timestamps for dates instead of strings This lets me easily create an ordered list of entries if the homepage is designed to list both blog posts and other content.
2020-02-08 14:47:47 +01:00
# Write the actual post through cheddar's about-filter mechanism
refactor(tazjin/blog): Extract post rendering to utility function To use cheddar for both the feed & web views, the rendering function is extracted a level up - this prevents duplicate renderer calls. Change-Id: I31812c5c3f905f2f84914c6a8ab7c14602227be1 Reviewed-on: https://cl.tvl.fyi/c/depot/+/1710 Tested-by: BuildkiteCI Reviewed-by: tazjin <mail@tazj.in>
2020-08-10 23:48:05 +02:00
cat ${renderMarkdown post.content} >> $out
feat(web/blog): Add Nix-based static blog generator This introduces a derivation which builds an instance of nginx statically serving my blog posts, though as of now no indexes are being generated and no XML feed is available. This is just the initial draft of this setup and not yet what shall be yielded in the end.
2020-02-08 14:33:13 +01:00
echo '</article>' >> $out
fix(web/blog): Correctly wrap footer content Name clash went undetected because I called this variable the same thing, oops. Change-Id: Iafa508f26887302b1c256088c50c68cd0ed7eea2 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3771 Tested-by: BuildkiteCI Reviewed-by: sterni <sternenseemann@systemli.org>
2021-11-04 16:23:47 +01:00
cat ${writeText "footer.html" (fullFooter footer)} >> $out
feat(web/blog): Add Nix-based static blog generator This introduces a derivation which builds an instance of nginx statically serving my blog posts, though as of now no indexes are being generated and no XML feed is available. This is just the initial draft of this setup and not yet what shall be yielded in the end.
2020-02-08 14:33:13 +01:00
'';
in {
refactor(web/blog): Configurable blog name and footer Required for actually using this generically for the TVL blog. Change-Id: I92d8d10341f9ab4f92c90f7976be261b3255a0f0 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3768 Tested-by: BuildkiteCI Reviewed-by: sterni <sternenseemann@systemli.org>
2021-11-02 14:34:20 +01:00
inherit isDraft isUnlisted renderPost;
feat(web/blog): Add Nix-based static blog generator This introduces a derivation which builds an instance of nginx statically serving my blog posts, though as of now no indexes are being generated and no XML feed is available. This is just the initial draft of this setup and not yet what shall be yielded in the end.
2020-02-08 14:33:13 +01:00
}
Reference in a new issue Copy permalink