personal-notes

A repo of my notes that is about anything that is not too detailed to talk about anything, really.

If you want to find my detailed notes on anything that I don’t know, you can find it here. Bear in mind that unlike this repo which contains .adoc files, the previously linked repo contains LaTeX files which means you need to have a LaTeX distribution to compile it. If you’re not familiar with LaTeX, I’ve written more about it how you can compile it yourself in the said repo.

For now, enjoy my whatever-the-crap-that-is-put-in-here. Like with the remote repo full of notes of things I do not know, the notes here are written with the priniciple of Feynman technique. At the very least, you could find something useful here.

Setup

In order to fully utilize this repo, you need the following programs installed:

Program	My version of the program as of this writing	Optional
Ruby	2.7.0
Asciidoctor	2.0.9
Slim	4.0.1	Yes
asciidoctor-pdf	1.5.3	Yes
asciidoctor-html5s	0.2.0	Yes

Note	You could also use make setup for a quick setup. Be sure to review it first before running.

Tour of the setup

Here’s what the setup should look like:

personal-notes
├── notes/
├── templates/
│   ├── input/
│   └── output/
├── LICENSE*
├── makefile*
├── manager.rb*
└── README.adoc*

• notes/ is entryway to all of the notes, obviously.

• templates/ is where the templates files are stored. There should be two more directories named input/ and output/.

• There’s a Ruby script named manager.rb which is a basic notes manager for the setup. It’s a CLI program and it can be run like a shell program.

# List all of the subcommands and the flags.
./manager.rb --help

# Compile all of the Asciidoctor documents with 16 threads.
# (Depending on the count of the notes, it is better to make it one since creating threads also take resources.)
# The compiled output is going to be in the `.output` folder.
./manager.rb compile --threadcount 16 --directory ./notes

# Create an Asciidoctor note.
# This will create an Asciidoctor file in `./path/to/folder/title-of-the-note.adoc`.
# (I recommend to use Hantemcli [https://github.com/foo-dogsquared/hantemcli] instead for this.)
./manager.rb create --title "Title of the note" --path ./path/to/folder

The build directory is located at .output with all of the directory structure being retained.

Style guide

The style guide of writing and expanding the notes can be found in my repo of personal style guides.

For a quick summary, there is the following list.

• Use Asciidoctor for writing notes.

• Make sure a date string formatted in ISO 8601 standard is present. It serves as the revision string of the document and should be updated in case the note is updated.

• Have the author name and the email present as well.

• Files should be named in kebab case.

• Document titles, sections, and subsections should be in sentence case.