Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tjex committed Oct 6, 2024
1 parent a68b044 commit 7dd1062
Showing 1 changed file with 53 additions and 31 deletions.
84 changes: 53 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,41 +6,55 @@

## Description

`zk` is a command-line tool helping you to maintain a plain text [Zettelkasten](https://zettelkasten.de/introduction/) or [personal wiki](https://en.wikipedia.org/wiki/Personal_wiki).
`zk` is a command-line tool helping you to maintain a plain text
[Zettelkasten](https://zettelkasten.de/introduction/) or
[personal wiki](https://en.wikipedia.org/wiki/Personal_wiki).

Looking for a [quick usage example?](https://zk-org.github.io/zk/tips/getting-started.html)
Looking for a
[quick usage example?](https://zk-org.github.io/zk/tips/getting-started.html)

Or want to see it in action? Checkout [Shivan's](https://github.com/shivan-s)
video, [_Note-taking System ALL Programmers Should Consider_](https://www.youtube.com/watch?v=UzhZb7e4l4Y).
video,
[_Note-taking System ALL Programmers Should Consider_](https://www.youtube.com/watch?v=UzhZb7e4l4Y).

### Highlights

* [Creating notes from templates](https://zk-org.github.io/zk/notes/note-creation.html)
* [Advanced search and filtering capabilities](https://zk-org.github.io/zk/notes/note-filtering.html) including [tags](https://zk-org.github.io/zk/notes/tags.html), links and mentions
* [Integration with your favorite editors](https://zk-org.github.io/zk/tips/editors-integration.html):
* [Any LSP-compatible editor](https://zk-org.github.io/zk/tips/editors-integration.html)
* [`zk-nvim`](https://github.com/zk-org/zk-nvim) for Neovim 0.8+
* [`zk-vscode`](https://github.com/zk-org/zk-vscode) for Visual Studio Code
* [Interactive browser](https://zk-org.github.io/zk/config/tool-fzf.html), powered by `fzf`
* [Git-style command aliases](https://zk-org.github.io/zk/config/config-alias.html) and [named filters](https://zk-org.github.io/zk/config/config-filter.html)
* [Made with automation in mind](https://zk-org.github.io/zk/tips/automation.html)
* [Notebook housekeeping](https://zk-org.github.io/zk/tips/notebook-housekeeping.html)
* [Future-proof, thanks to Markdown](https://zk-org.github.io/zk/tips/future-proof.html)
* Supports most Markdown syntax flavors
* Links: regular Markdown links, `[[Wikilinks]]` and Neuron's `[[Folgezettel links]]#`.
* Tags: `#hashtags`, `:colon:separated:tags:`, Bear's `#multi-word tags#`.
* [YAML frontmatter](https://zk-org.github.io/zk/notes/note-frontmatter.html)

[See the changelog](CHANGELOG.md) for the list of upcoming features waiting to be released.
> Note: Links in the below list are outbound ↗
- [Creating notes from templates](https://zk-org.github.io/zk/notes/note-creation.html)
- [Advanced search and filtering capabilities](https://zk-org.github.io/zk/notes/note-filtering.html)
including [tags](https://zk-org.github.io/zk/notes/tags.html), links and
mentions
- [Integration with your favorite editors](https://zk-org.github.io/zk/tips/editors-integration.html):
- [Any LSP-compatible editor](https://zk-org.github.io/zk/tips/editors-integration.html)
- [`zk-nvim`](https://github.com/zk-org/zk-nvim) for Neovim 0.8+
- [`zk-vscode`](https://github.com/zk-org/zk-vscode) for Visual Studio Code
- [Interactive browser](https://zk-org.github.io/zk/config/tool-fzf.html),
powered by `fzf`
- [Git-style command aliases](https://zk-org.github.io/zk/config/config-alias.html)
and [named filters](https://zk-org.github.io/zk/config/config-filter.html)
- [Made with automation in mind](https://zk-org.github.io/zk/tips/automation.html)
- [Notebook housekeeping](https://zk-org.github.io/zk/tips/notebook-housekeeping.html)
- [Future-proof, thanks to Markdown](https://zk-org.github.io/zk/tips/future-proof.html)
- Supports most Markdown syntax flavors
- Links: regular Markdown links, `[[Wikilinks]]` and Neuron's
`[[Folgezettel links]]#`.
- Tags: `#hashtags`, `:colon:separated:tags:`, Bear's `#multi-word tags#`.
- [YAML frontmatter](https://zk-org.github.io/zk/notes/note-frontmatter.html)

[See the changelog](CHANGELOG.md) for the list of upcoming features waiting to
be released.

### What `zk` is not

* A note editor.
* A tool to serve your notes on the web – for this, you may be interested in [Neuron](docs/tips/neuron.md) or [Gollum](https://github.com/gollum/gollum).
- A note editor.
- A tool to serve your notes on the web – for this, you may be interested in
[Neuron](docs/tips/neuron.md) or [Gollum](https://github.com/gollum/gollum).

## Install

[Check out the latest release](https://github.com/zk-org/zk/releases) for pre-built binaries for macOS and Linux (`zk` was not tested on Windows).
[Check out the latest release](https://github.com/zk-org/zk/releases) for
pre-built binaries for macOS and Linux (`zk` was not tested on Windows).

### Homebrew

Expand Down Expand Up @@ -73,15 +87,18 @@ apk add zk

### Arch Linux

You can install [the zk package](https://archlinux.org/packages/extra/x86_64/zk/) from the official repos.
You can install
[the zk package](https://archlinux.org/packages/extra/x86_64/zk/) from the
official repos.

```sh
sudo pacman -S zk
```

### Build from scratch

Make sure you have a working [Go 1.21+ installation](https://golang.org/), then clone the repository:
Make sure you have a working [Go 1.21+ installation](https://golang.org/), then
clone the repository:

```sh
$ git clone https://github.com/zk-org/zk.git
Expand All @@ -97,13 +114,18 @@ $ ./zk -h

## Contributing

We warmly welcome issues, PRs and [discussions](https://github.com/zk-org/zk/discussions).
We warmly welcome issues, PRs and
[discussions](https://github.com/zk-org/zk/discussions).

Here you can read [some useful info for contributing to `zk`](./CONTRIBUTING.md).
Here you can read
[some useful info for contributing to `zk`](./CONTRIBUTING.md).

## Related projects

* [Neuron](https://github.com/srid/neuron) – a great tool to publish a Zettelkasten on the web
* [Emanote](https://emanote.srid.ca/) – an improved successor to Neuron
* [sirupsen's zk](https://github.com/sirupsen/zk) – a collection of scripts with a similar purpose
* [zk-spaced](https://github.com/matze/zk-spaced) – spaced repetition plugin for zk
- [Neuron](https://github.com/srid/neuron) – a great tool to publish a
Zettelkasten on the web
- [Emanote](https://emanote.srid.ca/) – an improved successor to Neuron
- [sirupsen's zk](https://github.com/sirupsen/zk) – a collection of scripts with
a similar purpose
- [zk-spaced](https://github.com/matze/zk-spaced) – spaced repetition plugin for
zk

0 comments on commit 7dd1062

Please sign in to comment.