foodogsquared/website
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/website.git synced 2025-01-31 01:57:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
https://foodogsquared.one
302 Commits 6 Branches 0 Tags 27 MiB
Nix 27.6%
SCSS 23.4%
HTML 20.5%
Ruby 14.1%
TeX 7.5%
Other 6.9%
3d19d1a2d2
Go to file
Gabriel Arazas 3d19d1a2d2
Update patch creation script 
Now the script revolves around creating patches from multiple branches
as well as a revision of the prefix which is just simply assigning a
dedicated prefix instead of relying on the content directory.
2023-04-04 23:03:52 +08:00
.github/workflows Fix the webring build action 2023-03-26 16:32:16 +08:00
archetypes Update Hugo archetypes with current email address 2023-02-20 12:46:31 +08:00
assets Update the site styling 2023-04-04 19:31:19 +08:00
bin Update patch creation script 2023-04-04 23:03:52 +08:00
config/_default Configure site for chat block extension 2023-04-03 23:41:55 +08:00
content Reformat certain sections in "Using Neovim as a manpager" 2023-03-23 22:14:17 +08:00
data Update dark theme 2023-03-23 14:38:29 +08:00
gems Initialize chat block processor 2023-04-03 23:35:18 +08:00
i18n Create QoL improvements for code listings 2023-02-21 01:06:05 +08:00
layouts Create a precontent partial for miscellaneous tasks 2023-04-04 19:51:58 +08:00
static Configure site for chat block extension 2023-04-03 23:41:55 +08:00
.envrc Use flake by default 2022-11-22 23:10:53 +08:00
.gitignore Update .gitignore 2022-11-22 22:37:51 +08:00
flake.lock Add custom Asciidoctor extensions to load path 2023-02-25 12:11:54 +08:00
flake.nix Reformat codebase 2023-03-07 00:35:19 +08:00
Gemfile Write the script for automating patch creations from posts/ subbranches 2023-04-04 14:32:36 +08:00
Gemfile.lock Write the script for automating patch creations from posts/ subbranches 2023-04-04 14:32:36 +08:00
gemset.nix Write the script for automating patch creations from posts/ subbranches 2023-04-04 14:32:36 +08:00
go.mod Update Hugo dependencies 2023-04-03 23:36:32 +08:00
go.sum Update Hugo dependencies 2023-04-03 23:36:32 +08:00
LICENSE Update license year 2023-02-25 15:24:16 +08:00
Makefile Separate updating webring and building site steps 2023-02-27 18:45:22 +08:00
netlify.toml Revert Netlify build to GitHub Actions 2022-11-28 11:17:59 +08:00
README.adoc Update README 2023-03-25 13:40:05 +08:00
shell.nix Create a shadow asciidoctor executable for this project 2023-04-03 23:33:49 +08:00
treefmt.toml Add Rubocop to Gemfile 2023-03-07 00:28:10 +08:00

README.adoc

Table of Contents

My website featuring a fairly customized version of my More Contentful Hugo theme.

Setting things up

You need Nix package manager installed to easily replicate the development shell for this project. Otherwise, you might have to manually install the following components:

  • Hugo as it is the tool used to generate this website.

  • Go runtime as the Hugo project uses Hugo modules.

  • Git not only because it is the VCS this project uses but also because it is used for Hugo modules.

  • Asciidoctor as it is the content markup used for the Hugo site.

  • Ruby as this site uses custom Asciidoctor extensions.

  • openring for generating a webring which is used on the site homepage.

With the things installed, you can just clone the Git repo of this project, run make serve, and voila! You’re now a content creator!

Most of the usual tasks done with this project should be handled by this project already which is listed in its Makefile. You can view the file for more details but for the sake of completion, here are the following tasks.

  • Building the website with make serve.

  • Updating the Hugo modules with make update.

  • Easily creating a live server with make serve.

Workflow

The workflow should be pretty easy to get started. Here are the non-exhaustive guidelines for this project.

  • You can edit any text with the text editor of your choice.

  • The content uses Asciidoc markup with Asciidoctor toolchain.

  • The content also uses custom Asciidoctor extensions, all of which is cited on the Gemfile.

  • There is a Ruby gem for our own Asciidoctor extensions which is living at ./gems/.

The posts from this website have a certain folder structure to follow. All of them should have a dedicated folder named $PUBLISH_DATE_IN_ISO_FORMAT-$POST_TITLE_IN_KEBAB_CASE. For example, if you have a post titled "How to pick your nose" published on March 31 of 2023, you have to store it in a folder 2023-03-31-how-to-pick-your-nose in the content Hugo folder. You can easily create one with hugo new posts/$FOLDER_NAME/index.adoc.

Getting used to with Asciidoctor

This Hugo project uses Asciidoc markup with Asciidoctor due to more markup features found in it compared to Markdown. Not to mention, it easily allows extending the markup with its API which this project also makes use of. To get it working, you need to install the Ruby gem found in ./gems/.

Note
 If you have Nix, this is already handled for you so feel free to skip the following section.

  • Build the gem in the gems directory (i.e., cd gems && gem build asciidoctor-foodogsquared-extensions.gemspec)

  • Install the gem (i.e., gem install ./asciidoctor-foodogsquared-extensions-1.0.0.gem).

  • With the gem installed, you can make use of the Asciidoctor extensions from it.

Here’s a couple of macros with this extension.

  • An inline macro for easily linking manpages in a variety of websites (i.e., man:crontab[5], man:systemd.unit[5]).

  • An inline macro for GitHub (i.e., github:foo-dogsquared/nixos-config[], github:NixOS/nixpkgs[]) and GitLab (i.e., gitlab:gitlab-org/gitlab).

  • Yet another inline macro for linking SWHIDs (i.e., swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2[], swh:1:dir:d198bc9d7a6bcf6db04f476d29314f157507d505[]).

For more details, you can see ./gems/lib/asciidoctor for more details.

Deployment

This project uses Netlify to deploy the website. However, this uses GitHub Actions to build the website since Netlify is too limited for our this project needs.

The building step for this website should be the same as the (encouraged) workflow with Nix development shells. Hence, it should be run with make build and deploy the website with public/ folder.