chore: aligned docs to the template file for articles

knowledge base/bash.md

@@ -1,5 +1,7 @@
 # Bourne Again SHell
 
+## Table of contents <!-- omit in toc -->
+
 1. [TL;DR](#tldr)
 1. [Startup files loading order](#startup-files-loading-order)
 1. [Functions](#functions)
@@ -366,6 +368,8 @@ echo $RECORDED
 
 ## Sources
 
+All the references in the [further readings] section, plus the following:
+
 - [The Bash trap command]
 - [Bash startup files loading order]
 - [How to detect if a script is being sourced]
@@ -373,10 +377,17 @@ echo $RECORDED
 - [Speed up your command line navigation]
 - [6 Bash tricks you can use daily]
 
-<!-- internal references -->
+<!--
+  References
+  -->
+
+<!-- In-article sections -->
+[further readings]: #further-readings
+
+<!-- Knowledge base -->
 [trap]: trap.md
 
-<!-- external references -->
+<!-- Others -->
 [6 bash tricks you can use daily]: https://medium.com/for-linux-users/6-bash-tricks-you-can-use-daily-a32abdd8b13
 [bash startup files loading order]: https://youngstone89.medium.com/unix-introduction-bash-startup-files-loading-order-562543ac12e9
 [how to detect if a script is being sourced]: https://stackoverflow.com/questions/2683279/how-to-detect-if-a-script-is-being-sourced#28776166

knowledge base/beowulf cluster.md

@@ -60,10 +60,16 @@ See the [Vagrant example].
 
 ## Sources
 
+All the references in the [further readings] section, plus the following:
+
 - [beowulf.org][beowulf]
 - [Wikipedia]
 
-<!-- projects' references -->
+<!--
+  References
+  -->
+
+<!-- Upstream -->
 [apptainer]: https://github.com/apptainer/apptainer
 [beowulf]: https://beowulf.org/overview/
 [hkube]: https://hkube.io/
@@ -74,11 +80,16 @@ See the [Vagrant example].
 [singularity]: https://github.com/gmkurtzer/singularity
 [slurm]: https://slurm.schedmd.com/
 
-<!-- internal references -->
+<!-- In-article sections -->
+[further readings]: #further-readings
+
+<!-- Knowledge base -->
 [boinc]: boinc.md
+
+<!-- Files -->
 [vagrant example]: ../examples/vagrant/beowulf%20cluster/Vagrantfile
 
-<!-- external references -->
+<!-- Others -->
 [a container for hpc]: https://www.admin-magazine.com/HPC/Articles/Singularity-A-Container-for-HPC
 [a simple beowulf cluster]: http://www.kerrywong.com/2008/11/04/a-simple-beowulf-cluster/
 [building a beowulf cluster from old macbooks - part 1]: https://jondeaton.wordpress.com/2017/10/01/building-a-beowulf-cluster-from-old-macbooks-part-1/

knowledge base/bitwarden-cli.md

@@ -137,5 +137,9 @@ bw logout
 
 - [cheat.sh]
 
-<!-- external references -->
+<!--
+  References
+  -->
+
+<!-- Others -->
 [cheat.sh]: https://cheat.sh/bw

knowledge base/bluetooth.md

@@ -1,5 +1,12 @@
 # Bluetooth
 
+## Table of contents <!-- omit in toc -->
+
+1. [Troubleshooting](#troubleshooting)
+   1. [Bluetooth devices take a long time to connect](#bluetooth-devices-take-a-long-time-to-connect)
+   1. [Bluetooth devices cannot be used at login](#bluetooth-devices-cannot-be-used-at-login)
+1. [Sources](#sources)
+
 ## Troubleshooting
 
 ### Bluetooth devices take a long time to connect
@@ -36,4 +43,9 @@ In `/etc/bluetooth/main.conf`, under the `Policy` section, set `AutoEnable` to `
 
 - [Failing to use bluetooth keyboard at login]
 
+<!--
+  References
+  -->
+
+<!-- Others -->
 [failing to use bluetooth keyboard at login]: https://archived.forum.manjaro.org/t/failing-to-use-bluetooth-keyboard-at-login/145056/12

knowledge base/btrfs.md

@@ -3,6 +3,13 @@
 Copy on write (COW) filesystem for Linux.<br/>
 Features and benefits [here][introduction]. (Meta)Data profiles [here][mkfs.btrfs].
 
+## Table of contents <!-- omit in toc -->
+
+1. [TL;DR](#tldr)
+1. [Check differences between 2 snapshots](#check-differences-between-2-snapshots)
+1. [Further readings](#further-readings)
+1. [Sources](#sources)
+
 ## TL;DR
 
 ```sh
@@ -159,25 +166,30 @@ sudo snapper -c 'config' diff '445..446'
 
 ## Sources
 
+All the references in the [further readings] section, plus the following:
+
 - [cheat.sh]
 - [Does BTRFS have an efficient way to compare snapshots?]
 - [Determine if a BTRFS subvolume is read-only]
 
-<!-- upstream -->
+<!--
+  References
+  -->
 
+<!-- Upstream -->
 [documentation]: https://btrfs.readthedocs.io/en/latest/
 [introduction]: https://btrfs.readthedocs.io/en/latest/Introduction.html
 [mkfs.btrfs]: https://btrfs.readthedocs.io/en/latest/mkfs.btrfs.html
 [swapfile]: https://btrfs.readthedocs.io/en/latest/Swapfile.html
 
-<!-- internal references -->
+<!-- In-article sections -->
+[further readings]: #further-readings
 
+<!-- Knowledge base -->
 [snapper]: snapper.md
 
-<!-- external references -->
+<!-- Others -->
-
 [cheat.sh]: https://cheat.sh/btrfs
-[gentoo wiki]: https://wiki.gentoo.org/wiki/Btrfs
-
 [determine if a btrfs subvolume is read-only]: https://unix.stackexchange.com/questions/375645/determine-if-btrfs-subvolume-is-read-only#375646
 [does btrfs have an efficient way to compare snapshots?]: https://serverfault.com/questions/399894/does-btrfs-have-an-efficient-way-to-compare-snapshots#419444
+[gentoo wiki]: https://wiki.gentoo.org/wiki/Btrfs

knowledge base/calicoctl.md

@@ -1,5 +1,7 @@
 # Calicoctl
 
+## Table of contents <!-- omit in toc -->
+
 1. [TL;DR](#tldr)
 
 ## TL;DR

knowledge base/cfengine3.md

@@ -5,7 +5,6 @@
 1. [TL;DR](#tldr)
 1. [Installation](#installation)
 1. [Further readings](#further-readings)
-1. [Sources](#sources)
 
 ## TL;DR
 
@@ -65,15 +64,10 @@ cf-remote install --hub 'hub' --bootstrap 'hub'
 - [Website]
 - [Documentation]
 
-## Sources
+<!--
+  References
+  -->
 
-All the references in the [further readings] section, plus the following:
+<!-- Upstream -->
-
-<!-- upstream -->
 [documentation]: https://docs.cfengine.com/docs/master/
 [website]: https://cfengine.com/
-
-<!-- internal references -->
-[further readings]: #further-readings
-
-<!-- external references -->

knowledge base/cheat.sh.md

@@ -1,5 +1,10 @@
 # cheat.sh
 
+## Table of contents <!-- omit in toc -->
+
+1. [TL;DR](#tldr)
+1. [Further readings](#further-readings)
+
 ## TL;DR
 
 ```sh
@@ -25,4 +30,9 @@ curl cht.sh/go/:list
 
 - [website]
 
+<!--
+  References
+  -->
+
+<!-- Upstream -->
 [website]: https://cheat.sh/

knowledge base/chezmoi.md

@@ -2,6 +2,15 @@
 
 A multi-machine dotfile manager, written in Go.
 
+## Table of contents <!-- omit in toc -->
+
+1. [TL;DR](#tldr)
+1. [Save the current data to a remote repository](#save-the-current-data-to-a-remote-repository)
+1. [Gotchas](#gotchas)
+1. [Snippets](#snippets)
+1. [Further readings](#further-readings)
+1. [Sources](#sources)
+
 ## TL;DR
 
 ```sh
@@ -111,15 +120,25 @@ $
 - [Go text/template]
 - [Sprig]
 
-[user guide]: https://www.chezmoi.io/user-guide/setup/
-
-[go text/template]: https://pkg.go.dev/text/template
-[sprig]: https://masterminds.github.io/sprig/
-
 ## Sources
 
+All the references in the [further readings] section, plus the following:
+
 - [cheat.sh]
 - [custom data fields appear as all lowercase strings]
 
+<!--
+  References
+  -->
+
+<!-- Upstream -->
+[user guide]: https://www.chezmoi.io/user-guide/setup/
+
+<!-- In-article sections -->
+[further readings]: #further-readings
+
+<!-- Others -->
 [cheat.sh]: https://cheat.sh/chezmoi
 [custom data fields appear as all lowercase strings]: https://github.com/twpayne/chezmoi/issues/463
+[go text/template]: https://pkg.go.dev/text/template
+[sprig]: https://masterminds.github.io/sprig/

knowledge base/chmod.md

@@ -12,7 +12,9 @@ chmod --reference 'reference-file' 'changed-file'
 
 - [18 selected super-useful Linux one-liners]
 
-<!-- upstream -->
+<!--
-<!-- internal references -->
+  References
-<!-- external references -->
+  -->
+
+<!-- Others -->
 [18 selected super-useful linux one-liners]: https://medium.com/codex/18-selected-super-useful-linux-one-liners-398ba6d20f8c

knowledge base/clamav.md

@@ -1,5 +1,12 @@
 # ClamAV
 
+## Table of contents <!-- omit in toc -->
+
+1. [TL;DR](#tldr)
+1. [Gotchas](#gotchas)
+1. [Further readings](#further-readings)
+1. [Sources](#sources)
+
 ## TL;DR
 
 ```sh
@@ -51,10 +58,19 @@ find . -type f | parallel --group --jobs 0 -d '\n' clamscan {}
 
 - [Gentoo Wiki]
 
-[gentoo wiki]: https://wiki.gentoo.org/wiki/ClamAV
-
 ## Sources
 
+All the references in the [further readings] section, plus the following:
+
 - [Install ClamAV on Fedora Linux 35]
 
+<!--
+  References
+  -->
+
+<!-- In-article sections -->
+[further readings]: #further-readings
+
+<!-- Others -->
+[gentoo wiki]: https://wiki.gentoo.org/wiki/ClamAV
 [install clamav on fedora linux 35]: https://www.linuxcapable.com/how-to-install-clamav-on-fedora-35/

knowledge base/cloud-init.md

@@ -1,10 +1,12 @@
 # Cloud init
 
+## Table of contents <!-- omit in toc -->
+
 1. [TL;DR](#tldr)
-2. [Merge 2 or more files or parts](#merge-2-or-more-files-or-parts)
+1. [Merge 2 or more files or parts](#merge-2-or-more-files-or-parts)
    1. [In Terraform](#in-terraform)
-3. [Further readings](#further-readings)
+1. [Further readings](#further-readings)
-4. [Sources](#sources)
+1. [Sources](#sources)
 
 ## TL;DR
 
@@ -158,13 +160,19 @@ merge_type: 'list(append)+dict(recurse_array)+str()'
 
 ## Sources
 
+All the references in the [further readings] section, plus the following:
+
 - [Debugging cloud-init]
 - [Tutorial]
 - [Cloud-Init configuration merging]
 - [Terraform's cloud-init provider]
 - [How to test cloud-init locally with Vagrant]
 
-<!-- cloud-init documentation -->
+<!--
+  References
+  -->
+
+<!-- Upstream -->
 [debugging cloud-init]: https://cloudinit.readthedocs.io/en/latest/topics/debugging.html
 [examples]: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
 [merging user-data sections]: https://cloudinit.readthedocs.io/en/latest/topics/merging.html
@@ -173,10 +181,13 @@ merge_type: 'list(append)+dict(recurse_array)+str()'
 [tutorial]: https://cloudinit.readthedocs.io/en/latest/topics/tutorial.html
 [website]: https://cloud-init.io/
 
-<!-- internal references -->
+<!-- In-article sections -->
+[further readings]: #further-readings
+
+<!-- Files -->
 [docker cloud init example]: ../examples/cloud-init/docker.yum.yaml
 
-<!-- external references -->
+<!-- Others -->
 [cloud-init configuration merging]: https://jen20.dev/post/cloudinit-configuration-merging/
 [cloud-init multipart encoding issues]: https://github.com/hashicorp/terraform/issues/4794
 [how to test cloud-init locally with vagrant]: https://www.grzegorowski.com/how-to-test-cloud-init-locally-with-vagrant

knowledge base/cmp.md

@@ -29,16 +29,15 @@ All the references in the [further readings] section, plus the following:
 - [6 more terminal commands you should know]
 
 <!--
-  references
+  References
   -->
 
-<!-- upstream -->
+<!-- In-article sections -->
-<!-- article sections -->
 [further readings]: #further-readings
 
-<!-- knowledge base -->
+<!-- Knowledge base -->
 [comm]: comm.md
 
-<!-- others -->
+<!-- Others -->
 [6 more terminal commands you should know]: https://betterprogramming.pub/6-more-terminal-commands-you-should-know-3606cecdf8b6
 [man page]: https://linux.die.net/man/1/cmp

knowledge base/comm.md

@@ -44,17 +44,16 @@ All the references in the [further readings] section, plus the following:
 - [6 more terminal commands you should know]
 
 <!--
-  references
+  References
   -->
 
-<!-- upstream -->
+<!-- In-article sections -->
-<!-- article sections -->
 [further readings]: #further-readings
 
-<!-- knowledge base -->
+<!-- Knowledge base -->
 [cmp]: cmp.md
 
-<!-- others -->
+<!-- Others -->
 [6 more terminal commands you should know]: https://betterprogramming.pub/6-more-terminal-commands-you-should-know-3606cecdf8b6
 [check whether all lines of file occur in different file]: https://unix.stackexchange.com/questions/397747/check-whether-all-lines-of-file-occur-in-different-file#397749
 [man page]: https://linux.die.net/man/1/comm

knowledge base/conventional commits.md

@@ -24,5 +24,9 @@ A commit message should be structured as follows:
 
 - [Website]
 
-<!-- upstream -->
+<!--
+  References
+  -->
+
+<!-- Upstream -->
 [website]: https://www.conventionalcommits.org

knowledge base/cpupower.md

@@ -1,4 +1,4 @@
-# Cpufreq
+# Cpupower
 
 Default governor is _ondemand_ for older CPUs and kernels and _schedutil_ for new CPUs and kernels.
 
@@ -24,10 +24,19 @@ sudo cpupower frequency-set --governor schedutil
 
 - [CPU frequency scaling]
 
-[cpu frequency scaling]: https://wiki.archlinux.org/title/CPU_frequency_scaling
-
 ## Sources
 
+All the references in the [further readings] section, plus the following:
+
 - [CPU governer settings ignore nice load]
 
+<!--
+  References
+  -->
+
+<!-- In-article sections -->
+[further readings]: #further-readings
+
+<!-- Others -->
+[cpu frequency scaling]: https://wiki.archlinux.org/title/CPU_frequency_scaling
 [cpu governer settings ignore nice load]: https://forum.manjaro.org/t/cpu-governer-settings-ignore-nice-load/71476/3

knowledge base/cron.md

@@ -3,7 +3,6 @@
 ## Table of contents <!-- omit in toc -->
 
 1. [TL;DR](#tldr)
-1. [Further readings](#further-readings)
 1. [Sources](#sources)
 
 ## TL;DR
@@ -18,18 +17,13 @@ Files in `/etc/cron.hourly` and similar need to:
 sudo run-parts --report --test '/etc/cron.hourly'
 ```
 
-## Further readings
-
 ## Sources
 
-All the references in the [further readings] section, plus the following:
-
 - [Function of /etc/cron.hourly]
 
-<!-- upstream -->
+<!--
+  References
+  -->
 
-<!-- internal references -->
+<!-- Others -->
-[further readings]: #further-readings
-
-<!-- external references -->
 [Function of /etc/cron.hourly]: https://askubuntu.com/questions/7676/function-of-etc-cron-hourly#607974

knowledge base/crontab.md

@@ -1,5 +1,10 @@
 # Crontab
 
+## Table of contents <!-- omit in toc -->
+
+1. [TL;DR](#tldr)
+1. [Sources](#sources)
+
 ## TL;DR
 
 ```sh
@@ -35,4 +40,9 @@ sudo crontab -r -u other_user
 
 - [cheat.sh]
 
+<!--
+  References
+  -->
+
+<!-- Others -->
 [cheat.sh]: https://cheat.sh/crontab

knowledge base/cryptsetup.md

@@ -1,5 +1,13 @@
 # Cryptsetup
 
+## Table of contents <!-- omit in toc -->
+
+1. [TL;DR](#tldr)
+1. [Crypt a device](#crypt-a-device)
+1. [Troubleshooting](#troubleshooting)
+   1. [The process is killed due to too much memory used](#the-process-is-killed-due-to-too-much-memory-used)
+1. [Further readings](#further-readings)
+
 ## TL;DR
 
 ```sh
@@ -89,6 +97,11 @@ The solution is simple; either:
 - [btrfs man page]
 - [High memory usage when opening a LUKS2 partition]
 
+<!--
+  References
+  -->
+
+<!-- Others -->
 [arch linux wiki]: https://wiki.archlinux.org/index.php/dm-crypt/Device_encryption
 [btrfs man page]: https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs(5)
 [high memory usage when opening a luks2 partition]: https://gitlab.com/cryptsetup/cryptsetup/issues/372

knowledge base/cups.md

@@ -1,5 +1,10 @@
 # CUPS
 
+## Table of contents <!-- omit in toc -->
+
+1. [Administration](#administration)
+1. [Let users print](#let-users-print)
+
 ## Administration
 
 1. Add this line to `/etc/cups/cupsd.conf`

knowledge base/curl.md

@@ -1,5 +1,11 @@
 # cURL
 
+## Table of contents <!-- omit in toc -->
+
+1. [TL;DR](#tldr)
+1. [Apply settings to all connections](#apply-settings-to-all-connections)
+1. [Sources](#sources)
+
 ## TL;DR
 
 ```sh
@@ -101,10 +107,20 @@ config: "~/.config/curl"
 
 ## Sources
 
+All the references in the [further readings] section, plus the following:
+
 - [cheat.sh]
 - [How to ignore invalid and self signed ssl connection errors with curl]
 - [Config file]
 
+<!--
+  References
+  -->
+
+<!-- In-article sections -->
+[further readings]: #further-readings
+
+<!-- Others -->
 [cheat.sh]: https://cheat.sh/curl
 [config file]: https://everything.curl.dev/cmdline/configfile
 [how to ignore invalid and self signed ssl connection errors with curl]: https://www.cyberciti.biz/faq/how-to-curl-ignore-ssl-certificate-warnings-command-option/

knowledge base/date.md

@@ -1,5 +1,7 @@
 # Date
 
+## Table of contents <!-- omit in toc -->
+
 1. [TL;DR](#tldr)
 
 ## TL;DR

knowledge base/dd.md

@@ -2,6 +2,12 @@
 
 Convert and copy a file.
 
+## Table of contents <!-- omit in toc -->
+
+1. [TL;DR](#tldr)
+1. [Benchmark disks](#benchmark-disks)
+1. [Sources](#sources)
+
 ## TL;DR
 
 N and BYTES values may be followed by the following multiplicative suffixes:
@@ -78,18 +84,16 @@ dd if=/dev/zero of=/tmp/test4.img bs=8k count=10k
 dd if=/dev/zero of=/tmp/test4.img bs=512 count=1000 oflag=dsync
 ```
 
-## Further readings
-
 ## Sources
 
-All the references in the [further readings] section, plus the following:
-
 - [cheat.sh]
 - [Linux and Unix Test Disk I/O Performance With dd Command]
 
-<!-- upstream -->
+<!--
-<!-- internal references -->
+  References
-<!-- external references -->
+  -->
+
+<!-- Others -->
 [cheat.sh]: https://cheat.sh/dd
 [how to create a disk image in linux]: https://itstillworks.com/clone-hard-drive-ubuntu-6884403.html
 [linux and unix test disk i/o performance with dd command]: https://www.cyberciti.biz/faq/howto-linux-unix-test-disk-performance-with-dd-command/

knowledge base/debian.md

@@ -20,13 +20,17 @@ All the references in the [further readings] section, plus the following:
 
 - [Advice for new users on not breaking their Debian system]
 
-<!-- upstream -->
+<!--
+  References
+  -->
+
+<!-- Upstream -->
 [advice for new users on not breaking their debian system]: https://wiki.debian.org/DontBreakDebian
 
-<!-- internal references -->
+<!-- In-article sections -->
+[further readings]: #further-readings
+
+<!-- Knowledge base -->
 [armbian]: armbian.md
 [apt]: apt.md
 [dpkg]: dpkg.md
-[further readings]: #further-readings
-
-<!-- external references -->

knowledge base/dell hardware.md

@@ -14,11 +14,14 @@
 1. under the USB drive, select the USB flash drive that you would like to use to create the USB recovery media and check the button _I understand that the selected drive will be reformatted and existing data will be deleted._
 1. click _Download_ to begin downloading the operating system recovery image; once the process is complete, a summary screen is shown
 
-
 ## Sources
 
 - [How to download and use the Dell operating system recovery image in Microsoft Windows]
 
-[os recovery tool]: https://www.dell.com/support/home/en-us/drivers/osiso/
+<!--
+  References
+  -->
 
+<!-- Upstream -->
 [how to download and use the dell operating system recovery image in microsoft windows]: https://www.dell.com/support/kbdoc/en-us/000123667/how-to-download-and-use-the-dell-os-recovery-image-in-microsoft-windows
+[os recovery tool]: https://www.dell.com/support/home/en-us/drivers/osiso/

knowledge base/dhclient.md

@@ -1,5 +1,10 @@
 # Dhclient
 
+## Table of contents <!-- omit in toc -->
+
+1. [TL;DR](#tldr)
+1. [Further readings](#further-readings)
+
 ## TL;DR
 
 ```sh
@@ -15,6 +20,9 @@ sudo dhclient -r eth0
 
 - [Force the DHCP client to renew the IP address in Linux]
 
-<!-- internal references -->
+<!--
-<!-- external references -->
+  References
+  -->
+
+<!-- Others -->
 [force the dhcp client to renew the ip address in linux]: https://www.cyberciti.biz/faq/howto-linux-renew-dhcp-client-ip-address/

knowledge base/diagrams as code.md

@@ -1,9 +1,11 @@
 # Diagrams as code
 
+## Table of contents <!-- omit in toc -->
+
 1. [JavaScript](#javascript)
    1. [Mermaid](#mermaid)
-2. [Python](#python)
+1. [Python](#python)
-3. [Further readings](#further-readings)
+1. [Further readings](#further-readings)
 
 ## JavaScript
 
@@ -20,7 +22,11 @@ Use the `diagrams` library.
 - [Mermaid]
 - [Python's diagrams library]
 
-<!-- external references -->
+<!--
+  References
+  -->
+
+<!-- Upstream -->
 [mermaid]: https://mermaid.js.org
 [mermaid live editor]: https://mermaid.live/edit
 [python's diagrams library]: https://diagrams.mingrammer.com/

knowledge base/diff-highlight.md

@@ -6,7 +6,6 @@ Pretty diff highlighter with emphasis on changed words.
 
 1. [TL;DR](#tldr)
 1. [Further readings](#further-readings)
-1. [Sources](#sources)
 
 ## TL;DR
 
@@ -35,18 +34,13 @@ In `${HOME}/.gitconfig`:
 - [PyPi] page
 - [Git]
 
-## Sources
+<!--
+  References
+  -->
 
-All the references in the [further readings] section, plus the following:
+<!-- Upstream -->
-
-<!-- upstream -->
 [github]: https://github.com/tk0miya/diff-highlight
 [pypi]: https://pypi.org/project/diff-highlight/
 
-<!-- in-article references -->
+<!-- Knowledge base -->
-[further readings]: #further-readings
-
-<!-- internal references -->
 [git]: git.md
-
-<!-- external references -->

knowledge base/dig.md

@@ -4,4 +4,9 @@
 
 - [Using dig +trace to Understand DNS Resolution from Start to Finish]
 
+<!--
+  References
+  -->
+
+<!-- Others -->
 [using dig +trace to understand dns resolution from start to finish]: https://ns1.com/blog/using-dig-trace

knowledge base/dnf.md

@@ -157,12 +157,14 @@ All the references in the [further readings] section, plus the following:
 - [How to use YUM/DNF to downgrade or rollback some package updates?]
 - [How to lock kernel (or another package) on Fedora]
 
-<!-- upstream -->
+<!--
+  References
+  -->
 
-<!-- internal references -->
+<!-- In-article sections -->
-
+[further readings]: #further-readings
-<!-- external references -->
 
+<!-- Others -->
 [cheat.sh]: https://cheat.sh/dnf
 [how to install only security and bugfixes updates with dnf]: https://fedoramagazine.org/how-to-install-only-security-and-bugfixes-updates-with-dnf/
 [how to lock kernel (or another package) on fedora]: https://robbinespu.gitlab.io/posts/locking-package-fedora/

knowledge base/docker.md

@@ -1,5 +1,13 @@
 # Docker
 
+## Table of contents <!-- omit in toc -->
+
+1. [TL;DR](#tldr)
+1. [Daemon configuration](#daemon-configuration)
+1. [Containers configuration](#containers-configuration)
+1. [Gotchas](#gotchas)
+1. [Sources](#sources)
+
 ## TL;DR
 
 ```sh
@@ -155,6 +163,11 @@ Those files come from the volume the docker container is using for its root, and
 - [Configuring DNS]
 - [Cheatsheet]
 
+<!--
+  References
+  -->
+
+<!-- Others -->
 [arch linux wiki]: https://wiki.archlinux.org/index.php/Docker
 [cheatsheet]: https://collabnix.com/docker-cheatsheet/
 [configuring dns]: https://dockerlabs.collabnix.com/intermediate/networking/Configuring_DNS.html

knowledge base/dpkg.md

@@ -1,5 +1,11 @@
 # Dpkg
 
+## Table of contents <!-- omit in toc -->
+
+1. [TL;DR](#tldr)
+1. [Further readings](#further-readings)
+1. [Sources](#sources)
+
 ## TL;DR
 
 ```sh
@@ -44,11 +50,16 @@ All the references in the [further readings] section, plus the following:
 - [How to check if dpkg-architecture --list has all the architectures?]
 - [List of files installed from apt package]
 
-<!-- project's references-->
+<!--
+  References
+  -->
 
-<!-- internal references-->
+<!-- In-article sections -->
+[further readings]: #further-readings
+
+<!-- Knowledge base -->
 [apt]: apt.md
 
-<!-- external references-->
+<!-- Others -->
 [how to check if dpkg-architecture --list has all the architectures?]: https://askubuntu.com/questions/852115/how-to-check-if-dpkg-architecture-list-has-all-the-architectures#852120
 [list of files installed from apt package]: https://serverfault.com/questions/96964/list-of-files-installed-from-apt-package#96965

knowledge base/dual boot.md

@@ -22,6 +22,18 @@ Steps for all procedures:
    - disable fast boot
 1. in the bios, change disk mode from Intel's _RAID_ (Rapid .. .. Disk) to **AHCI** (.. .. .. ..)
 
+## Table of contents <!-- omit in toc -->
+
+1. [Create the installation media](#create-the-installation-media)
+1. [Fedora](#fedora)
+1. [Ubuntu](#ubuntu)
+   1. [Partitioning](#partitioning)
+   1. [Install Windows](#install-windows)
+   1. [Install Ubuntu](#install-ubuntu)
+   1. [Ubuntu Tweaks for XPS 9560](#ubuntu-tweaks-for-xps-9560)
+   1. [Reinstall Ubuntu](#reinstall-ubuntu)
+   1. [Additional notes](#additional-notes)
+
 ## Create the installation media
 
 1. Create Windows installation USB stick
@@ -152,8 +164,11 @@ If you need to reinstall ubuntu, you should be able to jump to #4 directly. If y
 - Ubuntu (GRUB) is the default boot option, both Ubuntu and Windows should be there
 - Additionally, you can bring up the UEFI boot screen pressing F12 as soon as you turn on the laptop
 
-## Further readings
+<!--
+  References
+  -->
 
+<!-- Others -->
 [luispabon's gist]: https://gist.github.com/luispabon/db2c9e5f6cc73bb37812a19a40e137bc
 [mdziekon's gist]: https://gist.github.com/mdziekon/221bdb597cf32b46c50ffab96dbec08a
 [ubuntu wiki community]: https://help.ubuntu.com/community/Full_Disk_Encryption_Howto_2019

knowledge base/duperemove.md

@@ -10,6 +10,12 @@ When given the `-d` option, `duperemove` also submits duplicated extents for ded
 
 `duperemove` can also take input from `fdupes`, given the `--fdupes` option.
 
+## Table of contents <!-- omit in toc -->
+
+1. [TL;DR](#tldr)
+1. [Further readings](#further-readings)
+1. [Sources](#sources)
+
 ## TL;DR
 
 ```sh
@@ -35,12 +41,27 @@ duperemove -Adhr --hashfile=path/to/hashfile \
   path/to/directory
 ```
 
-## Sources
+## Further readings
 
 - [Website]
-- [cheat.sh]
 - [manpage]
 
-[cheat.sh]: https://cheat.sh/duperemove
+## Sources
+
+All the references in the [further readings] section, plus the following:
+
+- [cheat.sh]
+
+<!--
+  References
+  -->
+
+<!-- Upstream -->
 [manpage]: https://markfasheh.github.io/duperemove/duperemove.html
 [website]: https://markfasheh.github.io/duperemove/
+
+<!-- In-article sections -->
+[further readings]: #further-readings
+
+<!-- Others -->
+[cheat.sh]: https://cheat.sh/duperemove

knowledge base/fedora linux.md

@@ -1,5 +1,13 @@
 # Fedora GNU/Linux
 
+## Table of contents <!-- omit in toc -->
+
+1. [Enable the RPM Fusion repositories](#enable-the-rpm-fusion-repositories)
+1. [Broadcom Wi-Fi drivers](#broadcom-wi-fi-drivers)
+1. [Enable ZFS management](#enable-zfs-management)
+1. [Use DNF from behind a proxy](#use-dnf-from-behind-a-proxy)
+1. [Sources](#sources)
+
 ## Enable the RPM Fusion repositories
 
 RPM Fusion provides software that the Fedora Project or Red Hat doesn't want to ship. That software is provided as precompiled RPMs for all current Fedora versions and current Red Hat Enterprise Linux or clones versions; you can use the RPM Fusion repositories with tools like yum and PackageKit.
@@ -45,5 +53,10 @@ Either:
 - [RPM fusion configuration]
 - [DNF update from behind SSL inspection proxy]
 
+<!--
+  References
+  -->
+
+<!-- Others -->
 [dnf update from behind ssl inspection proxy]: https://molo76.github.io/2017/07/04/dnf-update-behind-ssl-inspection-proxy.html
 [rpm fusion configuration]: https://rpmfusion.org/Configuration

knowledge base/find.md

@@ -1,5 +1,12 @@
 # Find
 
+## Table of contents <!-- omit in toc -->
+
+1. [TL;DR](#tldr)
+1. [Time specifications](#time-specifications)
+1. [Gotchas](#gotchas)
+1. [Sources](#sources)
+
 ## TL;DR
 
 ```sh
@@ -174,6 +181,11 @@ find / -newer file.txt -user wnj -print
 - [How to output file names surrounded with quotes in SINGLE line?]
 - [How to find all hardlinks in a folder?]
 
+<!--
+  References
+  -->
+
+<!-- Others -->
 [find . -type f -exec chmod 644 {} ;]: https://stackoverflow.com/questions/19737525/find-type-f-exec-chmod-644#22083532
 [how can i find broken symlinks?]: https://unix.stackexchange.com/questions/34248/how-can-i-find-broken-symlinks
 [how to find all hardlinks in a folder?]: https://askubuntu.com/questions/972121/how-to-find-all-hardlinks-in-a-folder#972244

knowledge base/firewalld.md

@@ -82,13 +82,24 @@ sudo firewall-offline-cmd --add-port='22/tcp' && sudo firewall-cmd --reload
 - [Website]
 - [Documentation]
 
-[documentation]: https://firewalld.org/documentation/
-[website]: https://firewalld.org/
-
 ## Sources
 
+All the references in the [further readings] section, plus the following:
+
 - [Open TCP Port on openSUSE Firewall]
 - [How To Set Up a Firewall Using firewalld on CentOS 8]
 
+<!--
+  References
+  -->
+
+<!-- Upstream -->
+[documentation]: https://firewalld.org/documentation/
+[website]: https://firewalld.org/
+
+<!-- In-article sections -->
+[further readings]: #further-readings
+
+<!-- Others -->
 [how to set up a firewall using firewalld on centos 8]: https://www.digitalocean.com/community/tutorials/how-to-set-up-a-firewall-using-firewalld-on-centos-8
 [open tcp port on opensuse firewall]: https://vazhavandan.blogspot.com/2020/08/open-tcp-port-on-opensuse-firewall.html

knowledge base/flatpak.md

@@ -55,6 +55,16 @@ flatpak history
 
 ## Sources
 
+All the references in the [further readings] section, plus the following:
+
 - [How to clean up Flatpak apps to clear disk space]
 
+<!--
+  References
+  -->
+
+<!-- In-article sections -->
+[further readings]: #further-readings
+
+<!-- Others -->
 [how to clean up flatpak apps to clear disk space]: https://www.debugpoint.com/2021/10/clean-up-flatpak/

knowledge base/freebsd.md

@@ -245,7 +245,11 @@ All the references in the [further readings] section, plus the following:
 - [Boinc]
 - [sbz's FreeBSD commands cheat-sheet]
 
-<!-- upstream -->
+<!--
+  References
+  -->
+
+<!-- Upstream -->
 [freebsd handbook]: https://docs.freebsd.org/en/books/handbook/
 [installing applications]: https://docs.freebsd.org/en/books/handbook/ports/
 [linux binary compatibility]: https://docs.freebsd.org/en/books/handbook/linuxemu/
@@ -253,11 +257,12 @@ All the references in the [further readings] section, plus the following:
 [using the ports collection]: https://docs.freebsd.org/en/books/handbook/ports/#ports-using
 [wayland]: https://docs.freebsd.org/en/books/handbook/wayland/
 
-<!-- internal references -->
+<!-- In-article sections -->
+[further readings]: #further-readings
 [manage binary packages with pkg]: #manage-binary-packages-with-pkg
 [manage ports from the ports collection]: #manage-ports-from-the-ports-collection
 
-<!-- external references -->
+<!-- Others -->
 [boinc]: https://people.freebsd.org/~pav/boinc.html
 [ntpdate - not updating to current time]: https://forums.freebsd.org/threads/ntpdate-not-updating-to-current-time.72847/
 [sbz's freebsd commands cheat-sheet]: https://github.com/sbz/freebsd-commands