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

doc: fix indication for default home directory (closes #228)

Browse Source
This commit is contained in:
Thomas Lambert
2023-03-01 15:21:07 +01:00
parent 7a3091b68f
commit d44fa0c6d9
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -145,7 +145,7 @@ create the defaults directories before first use.
```lua ```lua
require('telekasten').setup({ require('telekasten').setup({
home = '~/zettelkasten', -- Put the name of your notes directory here home = vim.fn.expand("~/zettelkasten"), -- Put the name of your notes directory here
}) })
``` ```
**NOTE:** For Windows users, please indicate the path as **NOTE:** For Windows users, please indicate the path as

14
doc/telekasten.txt
View File

@@ -174,7 +174,7 @@ telekasten.setup({opts})
Path to your main markdown / zettelkasten folder. This is where all Path to your main markdown / zettelkasten folder. This is where all
your notes will be stored. your notes will be stored.
Default: '~/zettelkasten' Default: 'vim.fn.expand("~/zettelkasten")'
---------------------- ----------------------
Note to Windows users: Note to Windows users:
@@ -218,21 +218,21 @@ telekasten.setup({opts})
Path to your daily notes, to separate them from 'normal' notes. Path to your daily notes, to separate them from 'normal' notes.
Accepts absolute path or sub-directory name. Accepts absolute path or sub-directory name.
Default: '~/zettelkasten/daily' Default: 'vim.fn.expand("~/zettelkasten/daily")'
*telekasten.settings.weeklies* *telekasten.settings.weeklies*
weeklies: ~ weeklies: ~
Path to your weekly notes, to separate them from 'normal' notes. Path to your weekly notes, to separate them from 'normal' notes.
Accepts absolute path or sub-directory name. Accepts absolute path or sub-directory name.
Default: '~/zettelkasten/weekly' Default: 'vim.fn.expand("~/zettelkasten/weekly")'
*telekasten.settings.templates* *telekasten.settings.templates*
templates: ~ templates: ~
Path to your note templates. Path to your note templates.
Accepts absolute path or sub-directory name. Accepts absolute path or sub-directory name.
Default: '~/zettelkasten/templates' Default: 'vim.fn.expand("~/zettelkasten/templates")'
*telekasten.settings.image_subdir* *telekasten.settings.image_subdir*
image_subdir: ~ image_subdir: ~
@@ -337,7 +337,7 @@ telekasten.setup({opts})
template. template.
Default: `nil` Default: `nil`
Example: `'~/zettelkasten/templates/basenote.md'` Example: `'vim.fn.expand("~/zettelkasten/templates/basenote.md")'`
*telekasten.settings.template_new_daily* *telekasten.settings.template_new_daily*
template_new_daily: ~ template_new_daily: ~
@@ -345,7 +345,7 @@ telekasten.setup({opts})
a template. a template.
Default: `nil` Default: `nil`
Example: `'~/zettelkasten/templates/daily.md'` Example: `'vim.fn.expand("~/zettelkasten/templates/daily.md")'`
*telekasten.settings.template_new_weekly* *telekasten.settings.template_new_weekly*
template_new_weekly: ~ template_new_weekly: ~
@@ -353,7 +353,7 @@ telekasten.setup({opts})
a template. a template.
Default: `nil` Default: `nil`
Example: `'~/zettelkasten/templates/weekly.md'` Example: `'vim.fn.expand("~/zettelkasten/templates/weekly.md")'`
*telekasten.settings.install_syntax* *telekasten.settings.install_syntax*
install_syntax:~ install_syntax:~