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

99 lines
3.1 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.
#
feat(tazjin/atom-feed): Add Nix functions for generating an Atom feed This only adds the feed generation functions, but does not yet wire it up to the blog content. This was implemented against https://validator.w3.org/feed/docs/atom.html and I've validated some generated example feeds with the W3 validator. Change-Id: Ide3ea90d3fa935047506aa87169100c2ead21284 Reviewed-on: https://cl.tvl.fyi/c/depot/+/1709 Tested-by: BuildkiteCI Reviewed-by: tazjin <mail@tazj.in>
2020-08-10 22:53:19 +02:00
# The post index is generated by //users/tazjin/homepage, not by this
# code.
chore: Rename pkgs->depot in all Nix file headers
2020-02-21 13:47:29 +01:00
{ depot, lib, ... }:
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
inherit (builtins) filter map hasAttr replaceStrings toFile;
chore: Rename pkgs->depot in all Nix file headers
2020-02-21 13:47:29 +01:00
inherit (depot.third_party) runCommandNoCC writeText;
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
inherit (depot.users.tazjin) 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
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;" ];
header = title: ''
<!DOCTYPE html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="tazjin&#39;s blog">
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
<link rel="stylesheet" type="text/css" href="/static/tazjin.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">
feat(tazjin/homepage): Add Atom feed for blog posts Change-Id: I9049e2cc3f5a2c491ccfad5595d60c01ad926e6d Reviewed-on: https://cl.tvl.fyi/c/depot/+/1712 Tested-by: BuildkiteCI Reviewed-by: tazjin <mail@tazj.in>
2020-08-11 00:38:07 +02:00
<link rel="alternate" type="application/atom+xml" title="Atom Feed" href="/feed.atom">
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
<title>tazjin&#39;s blog: ${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): 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
<h1><a class="blog-title" href="/">tazjin&#39;s interblag</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>
'';
footer = ''
<hr>
<footer>
<p class="footer">
<a class="uncoloured-link" href="https://tazj.in">homepage</a>
|
<a class="uncoloured-link" href="https://git.tazj.in/about">code</a>
|
<a class="uncoloured-link" href="https://twitter.com/tazjin">twitter</a>
</p>
<p class="lod">ಠ_ಠ</p>
</footer>
</body>
'';
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
draftWarning = toFile "draft.html" ''
<p class="cheddar-callout cheddar-warning">
<b>Note:</b> This post is a <b>draft</b>! Please do not share
the link to it without asking me first.
</p>
<hr>
'';
unlistedWarning = toFile "unlisted.html" ''
<p class="cheddar-callout cheddar-warning">
<b>Note:</b> This post is <b>unlisted</b>! Please do not share
the link to it without asking me first.
</p>
<hr>
'';
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
renderPost = post: runCommandNoCC "${post.key}.html" {} ''
cat ${toFile "header.html" (header post.title)} > $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
# 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
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
cat ${toFile "footer.html" footer} >> $out
'';
in {
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
inherit renderPost isDraft isUnlisted;
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