Skip to content

Commit

Permalink
update readme links to point to GitHub pages docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tjex committed Sep 17, 2024
1 parent 8e1b2d9 commit 97d2ecf
Showing 1 changed file with 11 additions and 14 deletions.
25 changes: 11 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,28 @@

`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? [Let's get started](docs/getting-started.md).
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).



### Highlights

* [Creating notes from templates](docs/notes/note-creation.md)
* [Advanced search and filtering capabilities](docs/notes/note-filtering.md) including [tags](docs/tags.md), links and mentions
* [Integration with your favorite editors](docs/tips/editors-integration.md):
* [Any LSP-compatible editor](docs/tips/editors-integration.md)
* [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
* (*unmaintained*) [`zk.nvim`](https://github.com/megalithic/zk.nvim) for Neovim 0.5+ by [Seth Messer](https://github.com/megalithic)
* [Interactive browser](docs/config/tool-fzf.md), powered by `fzf`
* [Git-style command aliases](docs/config/config-alias.md) and [named filters](docs/config-filter.md)
* [Made with automation in mind](docs/tips/automation.md)
* [Notebook housekeeping](docs/tips/notebook-housekeeping.md)
* [Future-proof, thanks to Markdown](docs/tips/future-proof.md)
* [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](docs/notes/note-frontmatter.md)
* [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.

Expand Down

0 comments on commit 97d2ecf

Please sign in to comment.