moving to hugo

This commit is contained in:
Phil Bajsicki 2024-09-28 01:26:46 +02:00
parent 45f4475476
commit 26323841da
2 changed files with 126 additions and 10 deletions

View file

@ -4,11 +4,13 @@ This is the git for my personal website. Nothing to see here, just pretty vanill
* Deployment * Deployment
I'm basing my own deployment of hugo on my server on [[https://jasonmurray.org/posts/2020/githugogen/][this article]] by Jason Murray. I don't have much to change here, and his way of deploying makes a lot of sense to me. I'm using a git hook to automatically purge and re-build the ~/public~ directory after each commit. I don't get enough traffic for this to be an inconvenience.
I'm breaking it up here with a lot of his comments, simply so I don't get lost when reviewing this in a few years/ months. I used some of [[https://jasonmurray.org/posts/2020/githugogen/][this article]] by Jason Murray to help me understand how git hooks work. I'm running [[https://forgejo.org/][Forgejo]], and this is a much more elegant and simple solution when compared to running Actions or other CI/CD tools.
#+begin_src sh :tangle .git/hooks/post-receive The post-receive hook is like so:
#+begin_src sh
#!/bin/bash #!/bin/bash
# Directory on the server where the website will be mapped. # Directory on the server where the website will be mapped.
export GIT_WORK_TREE=/srv/bajsicki.com export GIT_WORK_TREE=/srv/bajsicki.com
@ -20,14 +22,11 @@ echo "post-receive: Generating https://bajsicki.com with Hugo..."
mkdir -p $GIT_WORK_TREE mkdir -p $GIT_WORK_TREE
chmod 755 $GIT_WORK_TREE chmod 755 $GIT_WORK_TREE
# Check out the contents of the repository and extract the files to $GIT_WORK_TREE
git checkout -f main
# Remove any files already in the public directory, a fresh copy will be generated by hugo # Remove any files already in the public directory, a fresh copy will be generated by hugo
rm -rf $GIT_WORK_TREE/public rm -rf $GIT_WORK_TREE/public
# Generate the site with hugo # Generate the site with hugo
cd $GIT_WORK_TREE && /usr/bin/hugo cd $GIT_WORK_TREE && ./update.sh
# Fix any permission problems. # Fix any permission problems.
find $GIT_WORK_TREE/public -type f -print | xargs -d '\n' chmod 644 find $GIT_WORK_TREE/public -type f -print | xargs -d '\n' chmod 644
@ -35,3 +34,16 @@ find $GIT_WORK_TREE/public -type d -print | xargs -d '\n' chmod 755
echo "post-receive: Hugo site generation complete" echo "post-receive: Hugo site generation complete"
#+end_src #+end_src
The ~update.sh~ script is as dead simple as things get.
#+begin_src sh
#!/usr/bin/env sh
cd themes/hugo-tufte/
git reset --hard && git pull origin main -f
cd ../..
git reset --hard && git pull origin main -f
hugo
#+end_src

View file

@ -1,15 +1,119 @@
+++ +++
title = "Posts" title = "Blog"
lastmod = 2024-09-28T00:30:38+02:00 lastmod = 2024-09-28T01:22:47+02:00
draft = false draft = false
meta = true meta = true
type = "list" type = "list"
[menu] [menu]
[menu.nav] [menu.nav]
identifier = "posts" identifier = "blog"
weight = 30 weight = 30
+++ +++
## <span class="org-todo todo draft">draft</span> category {#category}
### <span class="org-todo todo draft">draft</span> Moving to Hugo {#moving-to-hugo}
:EXPORT_HUGO_MENU: :menu nav :weight 30
:EXPORT_HUGO_SECTION: blog
:EXPORT_FILE_NAME: moving-to-hugo
:CREATED: <span class="timestamp-wrapper"><span class="timestamp">&lt;2024-09-28 Sat 00:54&gt;</span></span>
:END:
It's been a long time since I started using the `ox-tufte` exporter to keep and maintain my website. However, I have had issues with it; one of the larger ones being that it's a pain in the butt to remember how it all works when I want to change the structure of it.
I also was a little tired of the look and layout; being presented with an endless table of contents isn't the best experience one could hope for online.
<!--more-->
Not to worry, I am in the midst of migrating most of my writing to Hugo!
Naturally, since I am a lover of prose and dearly enamored with sidenotes, I opted for [the hugo-tufte theme.](https://github.com/loikein/hugo-tufte) However, I immediately found some unpleasantness in it.
While I can and do appreciate whitespace, there is such a thing as too much. So I spent a number of hours fixing up the CSS (and a few minor things) more to my liking. at the same time, I realized that there are some limitations.
I won't bore you with the details, suffice to say I [forked the repo and started messing with it](https://git.bajsicki.com/phil/hugo-tufte). I'm not familiar or even remotely good with CSS/ HTML/ Hugo, so please don't expect miracles{{<sidenote>}}Also called 'clean code.'{{</sidenote>}}.
Most of my changes were minor; color scheme adjustments, decreasing the massive margins between the elements, getting some styling on the margin and side notes, and such.
One thing that I realized quickly was that the way sidenotes are implemented leads to them overlapping when they're close together; I have yet to find a solution for that, so for the time being, I am choosing to simply make the sidenote font smaller so they don't.
Other than that... I'm really happy with it.
Of course, I didn't stop there. Being the crazy person that I am, I wanted to automate deployment of my website through git.
And so I did. You can find the repo [here.](https://git.bajsicki.com/phil/bajsicki.com) The important bit lies on the server side.
I'm using a git hook to automatically purge and re-build the `/public` directory after each commit. I don't get enough traffic for this to be an inconvenience.
I used some of [this article](https://jasonmurray.org/posts/2020/githugogen/) by Jason Murray to help me understand how git hooks work. I'm running [Forgejo](https://forgejo.org/), and this is a much more elegant and simple solution when compared to running Actions or other CI/CD tools.
The post-receive hook is like so:
```sh
#!/bin/bash
# Directory on the server where the website will be mapped.
export GIT_WORK_TREE=/srv/bajsicki.com
echo `pwd`
echo "post-receive: Generating https://bajsicki.com with Hugo..."
# Create the directory and all subdirectories if they don't exist.
mkdir -p $GIT_WORK_TREE
chmod 755 $GIT_WORK_TREE
# Remove any files already in the public directory, a fresh copy will be generated by hugo
rm -rf $GIT_WORK_TREE/public
# Generate the site with hugo
cd $GIT_WORK_TREE && ./update.sh
# Fix any permission problems.
find $GIT_WORK_TREE/public -type f -print | xargs -d '\n' chmod 644
find $GIT_WORK_TREE/public -type d -print | xargs -d '\n' chmod 755
echo "post-receive: Hugo site generation complete"
```
The `update.sh` script is as dead simple as things get.
```sh
#!/usr/bin/env sh
cd themes/hugo-tufte/
git reset --hard && git pull origin main -f
cd ../..
git reset --hard && git pull origin main -f
hugo
```
In short... it just works, and I can easily transition my blogging/ websites to Hugo without compromising on my `org-mode addiction`.
All thanks to [ox-hugo](https://ox-hugo.scripter.co/), which made the process very easy, since I already had all of my articles in org-mode format in the first place.
I guess the last thing to mention are the sidenotes and margin notes... sadly, the way to use them with ox-hugo is quite cumbersome. My current process is to keep these two snippets in the kill-ring{{<sidenote>}}I will be moving them to yasnippet... at some point.{{</sidenote>}}, so I can easily insert them when needed.
```text
@@hugo:{{<sidenote>}}
{{</sidenote>}}@@
```
Then an example of it would look like this{{<sidenote>}}Or maybe not, I'm not sure.{{</sidenote>}}.
```text
@@hugo:{{<sidenote>}}Or maybe not, I'm not sure.{{</sidenote>}}@@
```
The same formatting applies to `marginnote`.
As you may notice, there is an issue. For some reason the hugo-tufte theme doesn't treat the sidenote number/ indicator as only a character, but adds a whitespace after it as well. This can lead to some hanging punctuation, so if you see that on this website, that's why. And if you don't, there's a tiny chance I fixed it.
Still, all things considered, I am quite happy, and working on this website has been a great reprieve from bombarding my brain with infosec.
<span class="underline">[Join the FSF.](https://my.fsf.org/join)</span>
## Tech <span class="tag"><span class="_tech">@tech</span></span> {#tech} ## Tech <span class="tag"><span class="_tech">@tech</span></span> {#tech}