File tree Expand file tree Collapse file tree 1 file changed +29
-5
lines changed Expand file tree Collapse file tree 1 file changed +29
-5
lines changed Original file line number Diff line number Diff line change @@ -4,16 +4,40 @@ This simple syntax for vim allows for easy creation of simple TODO files.
4
4
5
5
![ Preview] ( Images/Preview.jpg )
6
6
7
- Whitespaces don't matter and tabulation can be useful for tree-like structure:
7
+ Start a line with one of these characters for to highlight it with various colors:
8
+ | Character | Highlight Group |
9
+ | --- | --------- |
10
+ | ` - ` | Type |
11
+ | ` + ` | Statement |
12
+ | ` ! ` | Special |
13
+ | ` ? ` | Constant |
14
+ | ` / ` | Comment |
15
+
16
+
17
+ Whitespaces don't matter and indentation can be useful to create a tree-like structure:
8
18
9
19
![ Whitespaces don't matter] ( Images/Whitespaces.jpg )
10
20
21
+ All examples are shown in solarized light color palette. Colors depends on your color scheme.
22
+
11
23
## Installation
12
24
13
- Move ` todotxt.vim ` to ` ~/vimfiles/syntax ` (Windows) or ` ~/.vim/syntax ` (Unix)
25
+ <details >
26
+ <summary >Use your plugin manager (recommended)</summary >
14
27
15
- Also make sure that syntax is enabled in your ` vimrc ` file by ` syntax enable `
28
+ For example using [ vim-plug ] ( https://github.com/junegunn/vim-plug ) :
16
29
17
- [ More info about syntax files] ( https://vim.wikia.com/wiki/Creating_your_own_syntax_files )
30
+ ``` viml
31
+ Plug 'EtiamNullam/vim-todotxt-syntax'
32
+ ```
33
+ </details >
18
34
19
- All examples are shown in solarized light color palette. Unfortunately, right now colors will be off in other color schemes.
35
+ <details >
36
+ <summary >Manual</summary >
37
+
38
+ Move ` todotxt.vim ` to ` ~/vimfiles/syntax ` (Windows) or ` ~/.vim/syntax ` (Unix)
39
+ </details >
40
+
41
+ Also make sure that syntax is enabled in your config by ` syntax enable `
42
+
43
+ [ More info about syntax files] ( https://vim.wikia.com/wiki/Creating_your_own_syntax_files )
You can’t perform that action at this time.
0 commit comments