trducng
commited on
Commit
·
cfc4d48
1
Parent(s):
4b8aef4
Add orgmode file
Browse files
long.org
ADDED
@@ -0,0 +1,202 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
#+HTML: <div align="center">
|
2 |
+
|
3 |
+
#+HTML: <img alt="A blend of the Neovim (shape) and Org-mode (colours) logos" src="assets/nvim-orgmode.svg" width="250" /><br/>
|
4 |
+
|
5 |
+
* nvim-orgmode
|
6 |
+
|
7 |
+
#+HTML:<a href="/LICENSE"><img alt="License" src="https://img.shields.io/badge/license-MIT-brightgreen?style=flat-square"></a>
|
8 |
+
#+HTML:<a href="https://ko-fi.com/kristijanhusak"><img alt="Kofi" src="https://img.shields.io/badge/support-kofi-00b9fe?style=flat-square&logo=kofi"></a>
|
9 |
+
#+HTML:<a href="https://matrix.to/#/#neovim-orgmode:matrix.org"><img alt="Chat" src="https://img.shields.io/matrix/neovim-orgmode:matrix.org?logo=matrix&server_fqdn=matrix.org&style=flat-square"></a>
|
10 |
+
|
11 |
+
Orgmode clone written in Lua for Neovim
|
12 |
+
|
13 |
+
[[#installation][Installation]] • [[#docs][Docs]] • [[#showcase][Showcase]] • [[file:./docs/troubleshoot.org][Troubleshoot]] • [[#plugins][Plugins]] • [[file:./docs/contributing.org][Contributing]] • [[#thanks-to][Kudos]]
|
14 |
+
|
15 |
+
#+HTML:</div>
|
16 |
+
|
17 |
+
** Quickstart
|
18 |
+
|
19 |
+
*** Requirements
|
20 |
+
|
21 |
+
- Neovim 0.10.0 or later
|
22 |
+
|
23 |
+
*** Installation
|
24 |
+
:PROPERTIES:
|
25 |
+
:CUSTOM_ID: installation
|
26 |
+
:END:
|
27 |
+
|
28 |
+
Use your favourite package manager. We recommend [[https://github.com/folke/lazy.nvim][lazy.nvim]]:
|
29 |
+
#+BEGIN_SRC lua
|
30 |
+
{
|
31 |
+
'nvim-orgmode/orgmode',
|
32 |
+
event = 'VeryLazy',
|
33 |
+
ft = { 'org' },
|
34 |
+
config = function()
|
35 |
+
-- Setup orgmode
|
36 |
+
require('orgmode').setup({
|
37 |
+
org_agenda_files = '~/orgfiles/**/*',
|
38 |
+
org_default_notes_file = '~/orgfiles/refile.org',
|
39 |
+
})
|
40 |
+
|
41 |
+
-- NOTE: If you are using nvim-treesitter with ~ensure_installed = "all"~ option
|
42 |
+
-- add ~org~ to ignore_install
|
43 |
+
-- require('nvim-treesitter.configs').setup({
|
44 |
+
-- ensure_installed = 'all',
|
45 |
+
-- ignore_install = { 'org' },
|
46 |
+
-- })
|
47 |
+
end,
|
48 |
+
}
|
49 |
+
#+END_SRC
|
50 |
+
|
51 |
+
For more installation options see [[file:./docs/installation.org][Installation]] page.
|
52 |
+
|
53 |
+
*** Docs
|
54 |
+
:PROPERTIES:
|
55 |
+
:CUSTOM_ID: docs
|
56 |
+
:END:
|
57 |
+
|
58 |
+
Online docs is available at [[https://nvim-orgmode.github.io]].
|
59 |
+
|
60 |
+
To view docs in orgmode format in Neovim, run =:Org help=.
|
61 |
+
|
62 |
+
Vim help docs is available at =:help orgmode.txt=
|
63 |
+
*** Usage
|
64 |
+
|
65 |
+
- *Open agenda prompt*: =<Leader>oa=
|
66 |
+
- *Open capture prompt*: =<Leader>oc=
|
67 |
+
- In any orgmode buffer press =g?= for help
|
68 |
+
|
69 |
+
If you are new to Orgmode, see [[file:./docs/index.org#getting-started][Getting started]] section in the Docs.
|
70 |
+
|
71 |
+
** Showcase
|
72 |
+
:PROPERTIES:
|
73 |
+
:CUSTOM_ID: showcase
|
74 |
+
:END:
|
75 |
+
|
76 |
+
*** Agenda
|
77 |
+
|
78 |
+
#+CAPTION: agenda
|
79 |
+
#+NAME: agenda
|
80 |
+
[[https://user-images.githubusercontent.com/1782860/123549968-8521f600-d76b-11eb-9a93-02bad08b37ce.gif]]
|
81 |
+
|
82 |
+
*** Org file
|
83 |
+
|
84 |
+
#+CAPTION: orgfile
|
85 |
+
#+NAME: orgfile
|
86 |
+
[[https://user-images.githubusercontent.com/1782860/123549982-90752180-d76b-11eb-8828-9edf9f76af08.gif]]
|
87 |
+
|
88 |
+
*** Capturing and refiling
|
89 |
+
|
90 |
+
#+CAPTION: capture
|
91 |
+
#+NAME: capture
|
92 |
+
[[https://user-images.githubusercontent.com/1782860/123549993-9a972000-d76b-11eb-814b-b348a93df08a.gif]]
|
93 |
+
|
94 |
+
*** Autocompletion
|
95 |
+
|
96 |
+
#+CAPTION: autocomplete
|
97 |
+
#+NAME: autocomplete
|
98 |
+
[[https://user-images.githubusercontent.com/1782860/123550227-e8605800-d76c-11eb-96f6-c0a677d562d4.gif]]
|
99 |
+
|
100 |
+
** Features
|
101 |
+
|
102 |
+
*** TL;DR
|
103 |
+
|
104 |
+
- Agenda view
|
105 |
+
- Search by tags/keyword
|
106 |
+
- Clocking time
|
107 |
+
- Repeatable dates, date and time ranges
|
108 |
+
- Capturing to default notes file/destination
|
109 |
+
- Archiving (archive file or ARCHIVE tag)
|
110 |
+
- Exporting (via ~emacs~, ~pandoc~ and custom export options)
|
111 |
+
- Notifications (experimental, see issue [[https://github.com/nvim-orgmode/orgmode/issues/49][#49]])
|
112 |
+
- Calendar popup for easier navigation and date updates
|
113 |
+
- Various org file mappings:
|
114 |
+
- Promote/Demote
|
115 |
+
- Change TODO state
|
116 |
+
- Change dates
|
117 |
+
- Insert/Move/Refile headlines
|
118 |
+
- Change tags
|
119 |
+
- Toggle checkbox state
|
120 |
+
- Remote editing from agenda view
|
121 |
+
- Repeatable mapping via [[https://github.com/tpope/vim-repeat][vim-repeat]]
|
122 |
+
|
123 |
+
*** Detailed breakdown
|
124 |
+
|
125 |
+
- Agenda prompt:
|
126 |
+
- Agenda view (=a=):
|
127 |
+
- Ability to show daily(=vd=)/weekly(=vw=)/monthly(=vm=)/yearly(=vy=) agenda
|
128 |
+
- Support for various date settings:
|
129 |
+
- DEADLINE: Warning settings - example: ~<2021-06-11 Fri 11:00 -1d>~
|
130 |
+
- SCHEDULED: Delay setting - example: ~<2021-06-11 Fri 11:00 -2d>~
|
131 |
+
- All dates - Repeater settings:
|
132 |
+
- Cumulate type: ~<2021-06-11 Fri 11:00 +1w>~
|
133 |
+
- Catch-up type: ~<2021-06-11 Fri 11:00 ++1w>~
|
134 |
+
- Restart type: ~<2021-06-11 Fri 11:00 .+1w>~
|
135 |
+
- Time ranges - example: ~<2021-06-11 Fri 11:00-12:30>~
|
136 |
+
- Date ranges - example: ~<2021-06-11 Fri 11:00-12:30>--<2021-06-13 Sun 22:00>~
|
137 |
+
- Properly lists tasks according to defined dates (DEADLINE,SCHEDULED,Plain date)
|
138 |
+
- Navigate forward (=f=)/backward(=b=) or jump to specific date (=J=)
|
139 |
+
- Go to task under cursor in current window(=<CR>=) or other window(=<TAB>=)
|
140 |
+
- Print category from ":CATEGORY:" property if defined
|
141 |
+
- List tasks that have "TODO" state (=t=):
|
142 |
+
- Find headlines matching tag(s) (=m=):
|
143 |
+
- Search for headlines (and it's content) for a query (=s=):
|
144 |
+
- [[file:./docs/configuration.org#advanced-search][Advanced search]] for tags/todo kewords/properties
|
145 |
+
- Notifications (experimental, see issue [[https://github.com/nvim-orgmode/orgmode/issues/49][#49]])
|
146 |
+
- Clocking time
|
147 |
+
- Capture:
|
148 |
+
- Define custom templates
|
149 |
+
- Fast capturing to default notes file via =<C-c>=
|
150 |
+
- Capturing to specific destination =<Leader>or=
|
151 |
+
- Abort capture with =<Leader>ok=
|
152 |
+
- Org files
|
153 |
+
- Clocking time
|
154 |
+
- Refile to destination/headline: =<Leader>or=
|
155 |
+
- Increase/Decrease date under cursor: =<C-a>= / =<C-x>=
|
156 |
+
- Change date under cursor via calendar popup: =cid=
|
157 |
+
- Change headline TODO state: forward =cit= or backward =ciT=
|
158 |
+
- Open hyperlink or date under cursor: =<Leader>oo=
|
159 |
+
- Toggle checkbox: =<C-space>=
|
160 |
+
- Toggle current line to headline and vice versa: =<Leader>o*=
|
161 |
+
- Toggle folding of current headline: =<TAB>=
|
162 |
+
- Toggle folding in whole file: =<S-TAB>=
|
163 |
+
- Archive headline: =<Leader>o$=
|
164 |
+
- Add archive tag: =<Leader>oA=
|
165 |
+
- Change tags: =<Leader>ot=
|
166 |
+
- Promote headline: =<<=
|
167 |
+
- Demote headline: =>>=
|
168 |
+
- Promote subtree: =<s=
|
169 |
+
- Demote subtree: =>s=
|
170 |
+
- Add headline/list item/checkbox: =<Leader><CR>=
|
171 |
+
- Insert heading after current heading and it's content: =<Leader>oih=
|
172 |
+
- Insert TODO heading after current line: =<Leader>oiT=
|
173 |
+
- Insert TODO heading after current heading and it's content: =<Leader>oit=
|
174 |
+
- Move headline up: =<Leader>oK=
|
175 |
+
- Move headline down: =<Leader>oJ=
|
176 |
+
- Highlighted code blocks (~#+BEGIN_SRC filetype~)
|
177 |
+
Exporting (via ~emacs~, ~pandoc~ and custom export options)
|
178 |
+
|
179 |
+
Link to detailed documentation: [[./docs/index.org][DOCS]]
|
180 |
+
|
181 |
+
** Plugins
|
182 |
+
Check [[file:./docs/plugins.org][Plugins]] page for list of plugins.
|
183 |
+
|
184 |
+
#+BEGIN_QUOTE
|
185 |
+
*NOTE*: None of the Emacs Orgmode plugins will be built into nvim-orgmode.
|
186 |
+
Anything that's a separate plugin in Emacs Orgmode should be a separate plugin in here.
|
187 |
+
The point of this plugin is to provide functionality that's built into Emacs Orgmode core,
|
188 |
+
and a good foundation for external plugins.
|
189 |
+
#+END_QUOTE
|
190 |
+
|
191 |
+
If you want to build a plugin, post suggestions and improvements on [[https://github.com/nvim-orgmode/orgmode/issues/26][Plugins infrastructure]]
|
192 |
+
issue.
|
193 |
+
|
194 |
+
** Thanks to
|
195 |
+
:PROPERTIES:
|
196 |
+
:CUSTOM_ID: thanks-to
|
197 |
+
:END:
|
198 |
+
|
199 |
+
- [[https://github.com/dhruvasagar][@dhruvasagar]] and his [[https://github.com/dhruvasagar/vim-dotoo][vim-dotoo]] plugin
|
200 |
+
that got me started using orgmode. Without him this plugin would not happen.
|
201 |
+
- [[https://github.com/milisims][@milisims]] for writing a treesitter parser for org
|
202 |
+
- [[https://github.com/jceb/vim-orgmode][vim-orgmode]] for some parts of the code (mostly syntax)
|