Update docs and layouts

This commit is contained in:
Gabriel Arazas 2020-11-15 04:26:02 +08:00
parent 63fad8126f
commit 92a341d86a
4 changed files with 87 additions and 16 deletions

View File

@ -16,7 +16,10 @@ Though, it's obvious but then again, you may not remember how to do well in a ye
* Hugo * Hugo
* https://golang.org/[Go] runtime * https://golang.org/[Go] runtime
* https://asciidoctor.org/[Asciidoctor] * https://asciidoctor.org/[Asciidoctor]
* https://stedolan.github.io/jq/[jq]
* https://git.sr.ht/~sircmpwn/openring/[openring] (you can easily compile one yourself with the Go toolchain) * https://git.sr.ht/~sircmpwn/openring/[openring] (you can easily compile one yourself with the Go toolchain)
* https://www.gnu.org/software/make/[GNU Make] is optional but it'll make your life easier.
* https://nixos.org/[Nix] is also optional but it'll make your life into an enlightened functional package management heaven.
=== Setting up === Setting up
@ -28,7 +31,74 @@ hugo mod get -u
hugo serve hugo serve
---- ----
Or you could simply get a server running with `make serve` and bada-bing, bada-boom!
You're now a "content creator"!
The theme is a modified version of a https://github.com/foo-dogsquared/hugo-theme-more-contentful[modified version of a theme] so that's pretty cool. The theme is a modified version of a https://github.com/foo-dogsquared/hugo-theme-more-contentful[modified version of a theme] so that's pretty cool.
To create a post, simply make with `hugo new --kind post $PATH_REL_TO_CONTENT_DIR` and you're on your merry way. To create a post, simply make with `hugo new --kind post $PATH_REL_TO_CONTENT_DIR` and you're on your merry way.
=== Setting up with Nix
If you have Nix installed, it is even easier by creating a https://nix.dev/tutorials/ad-hoc-developer-environments.html[local development environment] for this project.
And it already has one in link:shell.nix[`shell.nix`].
Just run `nix-shell --pure shell.nix` and you're set.
An additional benefit with this setup is you don't have to manually compile https://git.sr.ht/~sircmpwn/openring/[openring] since the config already sets it for you.
Even better, you can set up an automatic shell environment with https://direnv.net/[direnv].
To use it, just add `.envrc`!
[source, bash]
----
echo "use nix" > .envrc && direnv allow
----
=== Deploying your blog
As of 2020-11-14, the blog is deployed into GitHub Pages with http://travis-ci.com/[Travis CI] for automation.
Feel free to copy the link:.travis.yml[`.travis.yml`] for an idea.
Nonetheless, it is easy to migrate between hosts since Hugo is fast and simple.
All you need to do is to run `make build`.
Then, upload the build artefacts into your host provider of choice.
== Project structure
[source, tree]
----
blog
├── archetypes/
├── assets/
├── bin/
├── content/
├── data/
├── layouts/
├── public/
├── resources/
├── static/
├── config.toml
├── go.mod
├── go.sum
├── Makefile
├── README.adoc
└── shell.nix
----
Among all of the files laid above, here are the points of interest you're most likely to interact (aside from the content folder).
* The link:./bin[`./bin`] directory contains custom scripts related for this project.
An example of which is a script (i.e., link:./bin/openring-create[`./bin/openring-create`]) that uses https://git.sr.ht/~sircmpwn/openring/[openring] to create a webring from my link:./data/blogs.json[public list of blogs I follow].
* link:./shell.nix[`./shell.nix`] is used for quickly creating a local project environment.
It can be only used when Nix is installed.
* The link:./data/[data folder] contains some of the https://github.com/foo-dogsquared/hugo-theme-more-contentful/[theme] configuration as well as relevant data for my customizations.
* The link:./layouts/[layout folder] contains theme overrides as well as additional components for custom content types (e.g., making appropriate templates for my gallery section, modifying the post section to be more readable).

View File

@ -24,6 +24,7 @@ footnote:[Feel free to randomly DM me about your recent tastes on music.]
I also https://www.youtube.com/channel/UCuMiU9bzATu5oTp-vhOlL2Q[create some crap music] but you're definitely not here for that. I also https://www.youtube.com/channel/UCuMiU9bzATu5oTp-vhOlL2Q[create some crap music] but you're definitely not here for that.
If you want a way on getting contact with me, you can shoot an email at `foo.dogsquared{at}gmail{dot}com`. If you want a way on getting contact with me, you can shoot an email at `foo.dogsquared{at}gmail{dot}com`.
Oh wait, I already said this in my homepage.
I'm open to your shenanigans as long as it's about dev-related or hobby-related (and legal, of course). I'm open to your shenanigans as long as it's about dev-related or hobby-related (and legal, of course).

View File

@ -15,7 +15,7 @@
<ul> <ul>
{{- range .Pages -}} {{- range .Pages -}}
<li> <li>
<date>{{ .Date.Format "2006-01-02" }}</date> - <date>{{ .PublishDate.Format "2006-01-02" }}</date> -
<a aria-label="{{ .Title }}" href="{{ .Permalink }}">{{ .Title }}</a> <a aria-label="{{ .Title }}" href="{{ .Permalink }}">{{ .Title }}</a>
</li> </li>
{{- end -}} {{- end -}}

View File

@ -5,61 +5,61 @@
<div class="webring__article"> <div class="webring__article">
<p class="webring__title"> <p class="webring__title">
<a href="https://sachachua.com/blog/2020/11/2020-11-02-emacs-news/" target="_blank" rel="noopener">2020-11-02 Emacs news</a> <a href="https://drewdevault.com/2020/11/06/Utility-vs-usability.html" target="_blank" rel="noopener">Utility vs usability</a>
</p> </p>
<span class="webring__metadata"> <span class="webring__metadata">
<small class="webring__source"> <small class="webring__source">
via <a href="https://sachachua.com/blog">sacha chua :: living an awesome life</a> via <a href="https://drewdevault.com">Drew DeVault&#39;s blog</a>
</small> </small>
<small class="webring__date">- <date datetime="2020-11-03 03:26:00 &#43;0000 &#43;0000">2020-11-03</date></small> <small class="webring__date">- <date datetime="2020-11-06 00:00:00 &#43;0000 &#43;0000">2020-11-06</date></small>
</span> </span>
</div> </div>
<div class="webring__article"> <div class="webring__article">
<p class="webring__title"> <p class="webring__title">
<a href="https://ma.ttias.be/cronweekly/issue-155/" target="_blank" rel="noopener">cron.weekly issue #155: Fedora, pandoc, youtube-dl, vdx &amp; more</a> <a href="https://kde.org/announcements/plasma-5.20.2/" target="_blank" rel="noopener">KDE Plasma 5.20.2, bugfix Release for October</a>
</p> </p>
<span class="webring__metadata"> <span class="webring__metadata">
<small class="webring__source"> <small class="webring__source">
via <a href="https://ma.ttias.be/cronweekly/">The cron.weekly newsletter on ma.ttias.be</a> via <a href="https://kde.org/announcements/">Announcements on KDE</a>
</small> </small>
<small class="webring__date">- <date datetime="2020-11-01 06:50:00 &#43;0100 &#43;0100">2020-11-01</date></small> <small class="webring__date">- <date datetime="2020-10-27 00:00:00 &#43;0000 &#43;0000">2020-10-27</date></small>
</span> </span>
</div> </div>
<div class="webring__article"> <div class="webring__article">
<p class="webring__title"> <p class="webring__title">
<a href="https://fasterthanli.me/articles/whats-in-a-rainbow-table" target="_blank" rel="noopener">What&#39;s in a Rainbow table?</a> <a href="https://the-missing-bit.com/post/2020-10-26-github/" target="_blank" rel="noopener">Moving away from Github</a>
</p> </p>
<span class="webring__metadata"> <span class="webring__metadata">
<small class="webring__source"> <small class="webring__source">
via <a href="https://fasterthanli.me">fasterthanli.me</a> via <a href="https://the-missing-bit.com/post/">Posts on The Missing Bit</a>
</small> </small>
<small class="webring__date">- <date datetime="2020-10-28 22:30:00 &#43;0000 &#43;0000">2020-10-28</date></small> <small class="webring__date">- <date datetime="2020-10-26 04:26:00 &#43;0100 &#43;0100">2020-10-26</date></small>
</span> </span>
</div> </div>
<div class="webring__article"> <div class="webring__article">
<p class="webring__title"> <p class="webring__title">
<a href="https://guix.gnu.org/blog/2020/online-guix-day-announce-1/" target="_blank" rel="noopener">Announcing the first online Guix Day Conference</a> <a href="https://emersion.fr/blog/2020/status-update-22/" target="_blank" rel="noopener">Status update, October 2020</a>
</p> </p>
<span class="webring__metadata"> <span class="webring__metadata">
<small class="webring__source"> <small class="webring__source">
via <a href="https://guix.gnu.org/blog/">GNU Guix — Blog</a> via <a href="https://emersion.fr/blog/">emersion</a>
</small> </small>
<small class="webring__date">- <date datetime="2020-10-16 00:00:00 &#43;0000 UTC">2020-10-16</date></small> <small class="webring__date">- <date datetime="2020-10-16 00:00:00 &#43;0200 &#43;0200">2020-10-16</date></small>
</span> </span>
</div> </div>
<div class="webring__article"> <div class="webring__article">
<p class="webring__title"> <p class="webring__title">
<a href="http://malloc47.com/migrating-to-nixos/" target="_blank" rel="noopener">Migrating to NixOS</a> <a href="https://blog.yoshuawuyts.com/rust-2021/" target="_blank" rel="noopener">Rust 2021</a>
</p> </p>
<span class="webring__metadata"> <span class="webring__metadata">
<small class="webring__source"> <small class="webring__source">
via <a href="http://malloc47.com/">malloc47</a> via <a href="https://blog.yoshuawuyts.com">Yoshua Wuyts — Blog</a>
</small> </small>
<small class="webring__date">- <date datetime="2019-03-14 00:00:00 &#43;0000 &#43;0000">2019-03-14</date></small> <small class="webring__date">- <date datetime="2020-09-24 00:00:00 &#43;0000 &#43;0000">2020-09-24</date></small>
</span> </span>
</div> </div>