Technical knowledge management system
Find a file
2024-04-20 12:40:04 +01:00
.vscode
.zk Autosave: 2024-04-20 12:40:04 2024-04-20 12:40:04 +01:00
scripts Autosave: 2024-04-14 21:50:03 2024-04-14 21:50:03 +01:00
zk Autosave: 2024-04-20 12:30:04 2024-04-20 12:30:04 +01:00
.gitignore Autosave: 2024-03-30 09:10:04 2024-03-30 09:10:04 +00:00
.prettierignore chore: create zettelkasten config 2024-02-17 16:29:36 +00:00
.prettierrc reformat all files to 80 char line length 2024-02-02 15:58:13 +00:00
README.md chore: add knowledge graph img to readme 2024-02-27 20:54:18 +00:00
stack_data_structure.md Autosave: 2024-04-20 12:40:04 2024-04-20 12:40:04 +01:00

Eólas


Eólas is Irish for knowledge or information, especially knowledge gained by experience or practice

This repository is my technical knowledge management system or "second-brain". It comprises notes from my autodidactic study of software engineering and computer science.

Implementation

It is a Zettelkasten work in progress. I've recently converted the topic-based subdirectories into a single flat directory structure organised by tags. I'm in the process of partitioning longer notes into smaller informational units.

I use the zk CLI package to help with indexing and task automation alongside its zk-nvim Neovim wrapper. I occassionally utilise Obsidian alongside Neovim for when I want to view my notes as a knowledge graph or read them alongside their rich content (images, videos etc).

Commands

Commands are local to my Linux machine, specified in my dotfiles. They are how I generate new entries and manage the knowledge base.

Alias Command Output
z cd $HOME/repos/eolas Access Zettelkasten
zn zk new --title ... Create new entry from template
<leader> zk :ZkNotes Access Zettelkasten from anywhere within nvim
<leader> zi :ZkIndex Index Zettelkasten within nvim
<leader> zt :ZkTags View tags via Telescope within nvim
<leader> ztt :ObsidianTags View tags in a Vim buffer via within nvim using obsidian-nvim
<leader> zl :ZkLinks View links in current entry via Telescope within nvim, using obsidian-nvim
<leader> zb :ZkBacklinks View backlinks to current entry via Telescope within nvim, using obsidian-nvim

Frontmatter

When I run the zn command this generates a new Zettelkasten entry with the following frontmatter template:

---
id: o8yzcrtv
title: test
tags: []
created: Saturday, February 17, 2024 | 17:44
---

Scripts

The scripts directory contains several Bash and Python scripts I use for general housekeeping, such as formatting image URLs, removing unused assets, and autosaving.

Autosave

I use a bash script to create autosave functionality via Git. This script runs every 15 minutes via a systemd time timer. It tidies up the directory (removes unused images, ensures all file names use underscores rather than spaces and hyphens etc) and commits and pushes to GitHub.