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

docs(WIP): major Readme simplification

Browse Source
This commit is contained in:
Thomas Lambert
2023-01-15 00:57:10 +01:00
parent b0e9016c35
commit 03a15524f6
2 changed files with 229 additions and 801 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1022
README.md
View File

File diff suppressed because it is too large Load Diff

8
doc/telekasten.txt
View File

@@ -30,6 +30,8 @@ CONTENTS
0. Note file naming .............. |telekasten.note_naming| 0. Note file naming .............. |telekasten.note_naming|
1. Setup ......................... |telekasten.setup| 1. Setup ......................... |telekasten.setup|
1.1 Requirements ..............|telekasten.requirements|
1.2 Configuration .............|telekasten.configuration|
2. Colors ........................ |telekasten.colors| 2. Colors ........................ |telekasten.colors|
3. Usage ......................... |telekasten.usage| 3. Usage ......................... |telekasten.usage|
3.1 Link Notation ............ |telekasten.link_notation| 3.1 Link Notation ............ |telekasten.link_notation|
@@ -53,6 +55,12 @@ Currently, the following file naming conventions are hard-coded:
================================================================================ ================================================================================
Section 1: Setup *telekasten.setup()* Section 1: Setup *telekasten.setup()*
*telekasten.requirements*
The following is a list of mandatory and optional requirements for running
Telekasten and some of its key features.
*telekasten.configuration*
telekasten.setup({opts}) telekasten.setup({opts})
Setup function to be run by user. Configures the defaults, markdown Setup function to be run by user. Configures the defaults, markdown
directories, templates, and optional calendar integration of telekasten. directories, templates, and optional calendar integration of telekasten.