jonas/telekasten.nvim
1
0
Fork 0
mirror of https://github.com/Ascyii/telekasten.nvim.git synced 2026-01-01 06:14:23 -05:00
Code Issues Packages Projects Releases Wiki Activity

u r + h

Browse Source
This commit is contained in:
Rene Schallner
2021-12-25 14:39:28 +01:00
parent 6434f91608
commit d19da7926f
2 changed files with 13 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -259,9 +259,6 @@ require('telekasten').setup({
close_after_yanking = false, close_after_yanking = false,
insert_after_inserting = true, insert_after_inserting = true,
-- make syntax available to markdown buffers and telescope previewers
install_syntax = true,
-- tag notation: '#tag', ':tag:', 'yaml-bare' -- tag notation: '#tag', ':tag:', 'yaml-bare'
tag_notation = "#tag", tag_notation = "#tag",
@@ -337,7 +334,6 @@ END
| `calendar_opts` | options for calendar, see below | see below | | `calendar_opts` | options for calendar, see below | see below |
| `close_after_yanking` | close telescope preview after yanking via <kbd>ctrl</kbd><kbd>y</kbd>| false | | `close_after_yanking` | close telescope preview after yanking via <kbd>ctrl</kbd><kbd>y</kbd>| false |
| `insert_after_inserting` | enter insert mode after inserting a link from a telescope picker via <kbd>ctrl</kbd><kbd>i</kbd>| true | | `insert_after_inserting` | enter insert mode after inserting a link from a telescope picker via <kbd>ctrl</kbd><kbd>i</kbd>| true |
| `install_syntax` | if `true`, telekasten's syntax for links, tags, etc. will be used for markdown files, also in telescope previewers. Your configured markdown syntax will be inherited, though. | true |
| `tag_notation` | the tag style you want to use| `#tag` | | `tag_notation` | the tag style you want to use| `#tag` |
| | - `#tag` (default) | | | | - `#tag` (default) | |
| | - `:tag:` | | | | - `:tag:` | |
@@ -659,8 +655,9 @@ The only symbols allowed are:
Numbers are allowed in tags, as long as a tag is not purely numeric. For example, #1984 is not a valid tag, but `#y1984` Numbers are allowed in tags, as long as a tag is not purely numeric. For example, #1984 is not a valid tag, but `#y1984`
is. is.
**Note**: For proper highlighting, the `install_syntax` option is set to `true` by default. This automatically sets the **Note**: For proper highlighting, the `auto_set_filetype` option is set to `true` by default. This automatically
syntax of filetype `markdown` to `telekasten`, and also registers this syntax with telescope previewers for `.md` files. switches the filetype of opened notes from `markdown` to `telekasten`, and also registers the syntax with telescope
previewers for `.md` files.
### 2.5 Note templates ### 2.5 Note templates
@@ -746,13 +743,13 @@ date: {{hdate}}
- **this**! - **this**!
- that! - that!
## Monday link ## Monday ......... [[{{monday}}]]
## Tuesday link ## Tuesday ......... [[{{tuesday}}]]
## Wednesday link ## Wednesday ......... [[{{wednesday}}]]
## Thursday link ## Thursday ......... [[{{thursday}}]]
## Friday link ## Friday ......... [[{{friday}}]]
## Saturday link ## Saturday ......... [[{{saturday}}]]
## Sunday link ## Sunday ......... [[{{sunday}}]]
``` ```
### 2.6 Using the calendar ### 2.6 Using the calendar

7
doc/telekasten.txt
View File

@@ -673,10 +673,9 @@ Tag syntax:~
example, #1984 is not a valid tag, but `#y1984` is. example, #1984 is not a valid tag, but `#y1984` is.
Note:~ Note:~
For proper highlighting, the `install_syntax` option is set to `true` by For proper highlighting, the `auto_set_filetype` option is set to `true` by
default. This automatically sets the syntax of filetype `markdown` to default. This automatically sets the to `telekasten`, and also registers the
`telekasten`, and also registers this syntax with telescope previewers for syntax with telescope previewers for `.md` files.
`.md` files.
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
Section 3.3: Templates *telekasten.templates* Section 3.3: Templates *telekasten.templates*