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

Update README.md

Browse Source 
Added notes about using `vim.fn.expand()` for the home directory working now for opening and browsing files.
This commit is contained in:
AustinS
2022-01-20 15:05:37 -06:00
committed by GitHub
parent 6c468934c4
commit ef687a9739
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -206,6 +206,7 @@ To avoid the most common Windows issue:
- Second best option: try WSL2 on Windows and pretend you're on Linux - Second best option: try WSL2 on Windows and pretend you're on Linux
- if you **must** use Windows, use `/Users/myname/zettelkasten` instead of `~/zettelkasten` - if you **must** use Windows, use `/Users/myname/zettelkasten` instead of `~/zettelkasten`
- **NEVER** use `C:\Users\myname` style paths - **NEVER** use `C:\Users\myname` style paths
- Using `vim.fn.expand("~/zettelkasten")` should work now but mileage will vary with anything outside of finding and opening files
```lua ```lua
lua << END lua << END
@@ -215,6 +216,7 @@ local home = vim.fn.expand("~/zettelkasten")
-- - try WSL2 on Windows and pretend you're on Linux -- - try WSL2 on Windows and pretend you're on Linux
-- - if you **must** use Windows, use "/Users/myname/zettelkasten" instead of "~/zettelkasten" -- - if you **must** use Windows, use "/Users/myname/zettelkasten" instead of "~/zettelkasten"
-- - NEVER use "C:\Users\myname" style paths -- - NEVER use "C:\Users\myname" style paths
-- - Using `vim.fn.expand("~/zettelkasten")` should work now but mileage will vary with anything outside of finding and opening files
require('telekasten').setup({ require('telekasten').setup({
home = home, home = home,
@@ -331,6 +333,7 @@ END
| | - try WSL2 on Windows and pretend you're on Linux | | | | - try WSL2 on Windows and pretend you're on Linux | |
| | - if you **must** use Windows, use `/Users/myname/zettelkasten` instead of `~/zettelkasten` | | | | - if you **must** use Windows, use `/Users/myname/zettelkasten` instead of `~/zettelkasten` | |
| | - **NEVER** use `C:\Users\myname` style paths | | | | - **NEVER** use `C:\Users\myname` style paths | |
| | - Using `vim.fn.expand("~/zettelkasten")` should work now but mileage will vary with anything outside of finding and opening files | |
| **`take_over_my_home`** | if set to `true` (default), telekasten will take over your home. Any notes from the configured `home` directory will receive a `set filetype=telekasten`, no matter if opened by telekasten or another way. | true | | **`take_over_my_home`** | if set to `true` (default), telekasten will take over your home. Any notes from the configured `home` directory will receive a `set filetype=telekasten`, no matter if opened by telekasten or another way. | true |
| `dailies` | path where your daily notes go | ~/zettelkasten/daily | | `dailies` | path where your daily notes go | ~/zettelkasten/daily |
| `weeklies` | path where your weekly notes go | ~/zettelkasten/weekly | | `weeklies` | path where your weekly notes go | ~/zettelkasten/weekly |