mirror of https://github.com/mickael-menu/zk
Add a [format.markdown] config section to customize tags syntax
parent
f5b3102deb
commit
9fda155a99
@ -1,5 +1,5 @@
|
|||||||
# A future-proof notebook
|
# A future-proof notebook
|
||||||
|
|
||||||
`zk` is designed to be future-proof and rely on simple plain text formats such as Markdown.
|
`zk` is designed to be future-proof and rely on simple [plain text formats](note-format.md) such as Markdown.
|
||||||
|
|
||||||
The shape of your [notebook](notebook.md) is entirely up to you, making `zk` flexible enough to be used in a variety of contexts. However, `zk` shines in a Zettelkasten-style notebook with many small interlinked notes.
|
The shape of your [notebook](notebook.md) is entirely up to you, making `zk` flexible enough to be used in a variety of contexts. However, `zk` shines in a Zettelkasten-style notebook with many small interlinked notes.
|
||||||
|
@ -0,0 +1,13 @@
|
|||||||
|
# Note formats
|
||||||
|
|
||||||
|
To keep your notebooks [future-proof](future-proof.md), `zk` uses a simple plain text format for your notes. Only Markdown is supported at the moment, but more formats may be added in the future.
|
||||||
|
|
||||||
|
You can set up some features of `zk`'s Markdown parser from your [configuration file](config.md), under the `[format.markdown]` section.
|
||||||
|
|
||||||
|
| Setting | Default | Description |
|
||||||
|
|------------------|---------|------------------------------------------------------------------------|
|
||||||
|
| `hashtags ` | `true` | Enable `#hashtags` support |
|
||||||
|
| `colon-tags` | `false` | Enable `:colon:separated:tags:` support |
|
||||||
|
| `multiword-tags` | `false` | Enable Bear's [`#multi-word tags#`][1]. Hashtags must also be enabled. |
|
||||||
|
|
||||||
|
[1]: https://blog.bear.app/2017/11/bear-tips-how-to-create-multi-word-tags/
|
Loading…
Reference in New Issue