thomasabishop/eolas
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update readme

Browse source
This commit is contained in:
thomasabishop 2024-02-26 19:58:39 +00:00
parent c3ce1a7e87
commit fb9928e74c
1 changed files with 20 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -9,10 +9,10 @@ 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.
It is a [Zettelkasten](https://en.wikipedia.org/wiki/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](https://github.com/zk-org/zk) CLI package to help with indexing
and task automation alongside its [zk-nvim](https://github.com/zk-org/zk-nvim)
@ -26,15 +26,16 @@ Commands are local to my Linux machine, specified in my
[dotfiles](https://github.com/thomasabishop/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](https://github.com/nvim-telescope/telescope.nvim) within `nvim` |
| `<leader> zl` | `:ZkLinks` | View links in current entry via Telescope within `nvim` |
| `<leader> zb` | `:ZkBacklinks` | View backlinks to current entry via Telescope within `nvim` |
| 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](https://github.com/nvim-telescope/telescope.nvim) within `nvim` |
| `<leader> ztt` | `:ObsidianTags` | View tags in a Vim buffer via within `nvim` using [obsidian-nvim](https://github.com/epwalsh/obsidian.nvim) |
| `<leader> zl` | `:ZkLinks` | View links in current entry via Telescope within `nvim`, using [obsidian-nvim](https://github.com/epwalsh/obsidian.nvim) |
| `<leader> zb` | `:ZkBacklinks` | View backlinks to current entry via Telescope within `nvim`, using [obsidian-nvim](https://github.com/epwalsh/obsidian.nvim) |
## Frontmatter
@ -46,8 +47,7 @@ following frontmatter template:
id: o8yzcrtv
title: test
tags: []
date: Saturday, February 17, 2024 | 17:44
since: just now
created: Saturday, February 17, 2024 | 17:44
---
```
@ -55,12 +55,13 @@ since: just now
The [scripts](/scripts) directory contains several Bash and Python scripts I use
for general housekeeping, such as formatting image URLs, removing unused assets,
and automating commits.
and autosaving.
## Autosave
I use a [bash script](./scripts/auto_save.sh) to create autosave functionality
via Git. This script runs every 15 minutes via a [systemd](https://systemd.io/)
via Git. This script runs every 15 minutes via a
[systemd time](https://github.com/thomasabishop/dotfiles/tree/master/systemd/zettelkasten_autosave)
timer. It tidies up the directory (removes unused images, ensures all file names
use underscores rather than spaces and hyphens etc) and also runs the indexation
command then commits and pushes to GitHub.
use underscores rather than spaces and hyphens etc) and commits and pushes to
GitHub.