Skip to content

Commit 2b91d9a

Browse files
chore(docs): Add store.md file for store.nvim integration
1 parent ffa4d80 commit 2b91d9a

File tree

1 file changed

+220
-0
lines changed

1 file changed

+220
-0
lines changed

store.md

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

0 commit comments

Comments
 (0)