diff options
author | Jersey <fonseca@uchicago.edu> | 2020-06-24 20:37:08 +0000 |
---|---|---|
committer | Jersey <fonseca@uchicago.edu> | 2020-06-24 20:37:08 +0000 |
commit | 6b118944809f42d3af2a1b20f71f1aad580dc08d (patch) | |
tree | f653b37999204ae5a3ce813d674c1f71f35f6efe | |
parent | 90e5518188c66bbdb40398a7f0c88ca1f1115958 (diff) |
First release
-rw-r--r-- | README.md | 55 | ||||
-rw-r--r-- | doc/bujo.txt | 55 | ||||
-rw-r--r-- | plugin/bujo.vim | 12 |
3 files changed, 109 insertions, 13 deletions
@@ -1,2 +1,53 @@ | |||
1 | # vim-bullet-journal | 1 | ### vim-bujo |
2 | I like bullet journals. I like vim. | 2 | |
3 | This plugin allows people to easily access and manage a minimalist todo list from vim. | ||
4 | |||
5 | |||
6 | ## Installation | ||
7 | |||
8 | If you use a plugin manager, such as [vim-plug], follow its instructions on how to install plugins from github. | ||
9 | |||
10 | To install the stable version of the plugin, if using [vim-plug], put this in your `vimrc`/`init.vim`: | ||
11 | |||
12 | ``` | ||
13 | Plug 'jfonseca8/vim-bujo' | ||
14 | ``` | ||
15 | |||
16 | |||
17 | ## Use | ||
18 | |||
19 | * Conveniently open your todo list in vim | ||
20 | - Run :Todo | ||
21 | * Easily insert a new task | ||
22 | - Press <Ctrl-Enter> | ||
23 | * Easily check off a task | ||
24 | - Press <Ctrl-Backspace> | ||
25 | |||
26 | |||
27 | ## Screenshots | ||
28 | |||
29 | This gif shows how the TODO list opens up in vim. | ||
30 | |||
31 | We can also see simple controls used to manage the task list itself. | ||
32 | |||
33 | ## Notes | ||
34 | |||
35 | Feedback and bug reports are welcomed and encouraged. | ||
36 | If you want new features, please do let me know. I | ||
37 | would be honored at the opportunity to make a tool | ||
38 | better for the community. | ||
39 | |||
40 | I built this because I wanted the ease of vim bindings | ||
41 | with the benefits of keeping a todo list on hand. It is | ||
42 | very simple and minimialist. | ||
43 | |||
44 | I plan to add diary capabilities, calendar views, history, | ||
45 | and all the fun little quotes and activities that make actual | ||
46 | bullet journaling fun! | ||
47 | |||
48 | If you would like to work on this project with me, please | ||
49 | reach out to me on [twitter] | ||
50 | |||
51 | |||
52 | [twitter]: https://twitter.com/FonsecaJersey | ||
53 | [vim-plug]: https://github.com/junegunn/vim-plug | ||
diff --git a/doc/bujo.txt b/doc/bujo.txt new file mode 100644 index 0000000..c74d128 --- /dev/null +++ b/doc/bujo.txt | |||
@@ -0,0 +1,55 @@ | |||
1 | *bujo.txt* *bujo.txt* | ||
2 | Bujo~ | ||
3 | Bullet Journal Vim Plugin~ | ||
4 | |||
5 | Author: Jersey Fonseca <jerseyfonseca@gmail.com> | ||
6 | |||
7 | Version: 0.1 | ||
8 | |||
9 | 1. Overview | ||
10 | 2. Features | ||
11 | 3. FAQ | ||
12 | |||
13 | ======================================================= | ||
14 | *bujo-overview* | ||
15 | 1. Overview~ | ||
16 | |||
17 | This plugin allows people to easily access and | ||
18 | manage a todo list. | ||
19 | |||
20 | You can stable versions of this plugin at: | ||
21 | |||
22 | https://github.com/jfonseca8/vim-bujo | ||
23 | |||
24 | Feedback and bug reports are welcomed and encouraged. | ||
25 | If you want new features, please do let me know. I | ||
26 | would be honored at the opportunity to make a tool | ||
27 | better. | ||
28 | |||
29 | I built this because I wanted the ease of vim bindings | ||
30 | with the benefits of keeping a todo list on hand. It is | ||
31 | very simple and minimialist. | ||
32 | |||
33 | ======================================================= | ||
34 | *bujo-features* | ||
35 | 2. Features~ | ||
36 | |||
37 | * Conveniently open your todo list in vim | ||
38 | - Run :Todo | ||
39 | * Easily insert a new task | ||
40 | - Press <Ctrl-Enter> | ||
41 | * Easily check off a task | ||
42 | - Press <Ctrl-Backspace> | ||
43 | |||
44 | ======================================================= | ||
45 | *bujo-notes* | ||
46 | 3. Notes | ||
47 | |||
48 | I am not sure that writing this todo file into the root | ||
49 | directory is the best way to go about it. I have never | ||
50 | made anything like this, and couldn't find resources | ||
51 | that were helpful with how to handle such situations. | ||
52 | |||
53 | If this annoys anyone, please do let me know. I am | ||
54 | happy to change it, and happy to know if there are | ||
55 | better standardized ways to go about this | ||
diff --git a/plugin/bujo.vim b/plugin/bujo.vim index cc8a84e..9531421 100644 --- a/plugin/bujo.vim +++ b/plugin/bujo.vim | |||
@@ -1,17 +1,7 @@ | |||
1 | autocmd BufWritePre,FileWritePre todo.md ks|call LastMod()|'s | ||
2 | fun LastMod() | ||
3 | if line("$") > 20 | ||
4 | let l = 20 | ||
5 | else | ||
6 | let l = line("$") | ||
7 | endif | ||
8 | exe "1," . l . "g/Date: /s/Date: .*/Date: " . | ||
9 | \ strftime("%Y %b %d") | ||
10 | endfun | ||
11 | |||
12 | "Make bujo directory if it doesn't exist" | 1 | "Make bujo directory if it doesn't exist" |
13 | if empty(glob('~/bujo')) | 2 | if empty(glob('~/bujo')) |
14 | call mkdir($HOME . '/bujo', 'p') | 3 | call mkdir($HOME . '/bujo', 'p') |
4 | |||
15 | endif | 5 | endif |
16 | 6 | ||
17 | " Open the bujo todo list file | 7 | " Open the bujo todo list file |