From 6c03b725285cdcb6fae26c6e465637fdbac4f32e Mon Sep 17 00:00:00 2001 From: Benjamin Chausse Date: Thu, 30 May 2024 11:05:17 -0400 Subject: [PATCH] Migrate from README.md to README.org (#739) * Migrate headings and code blocks * Migrate inline code to ~code~ notation * Migrate most links and images * Fix title * cope with Github's broken headline hierarchy * Migrate embedded html * Migrate Headline logo and goodies/buttons * Safer option for main logo * Second attempt at logo+goodie formatting * Title under logo * Kofi Chat and other logos * Replace tags with =key= notation * Capitalize BEGIN_SRC & END_SRC for consistency * Fix html linebreak * Fix mismatched code block * no need to escape < > for vim keys (i.e. ) * Attempt to fix kofi icon * One more time * Multiple formating fixes * More minor changes * Add alt-text to top buttons * Fix small formatting issues (almost complete) * attempt to use native org checkboxes * "Fix" checkboxes with emojis * More emoji fixes * Small inline code fix * Fix small typo --------- Co-authored-by: Kristijan Husak --- README.md | 383 ---------------------------------------------------- README.org | 387 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 387 insertions(+), 383 deletions(-) delete mode 100644 README.md create mode 100644 README.org diff --git a/README.md b/README.md deleted file mode 100644 index efa99bfd4..000000000 --- a/README.md +++ /dev/null @@ -1,383 +0,0 @@ -
- A blend of the Neovim (shape) and Org-mode (colours) logos - -# nvim-orgmode - -![License](https://img.shields.io/badge/license-MIT-brightgreen?style=flat-square) ![Kofi](https://img.shields.io/badge/support-kofi-00b9fe?style=flat-square&logo=kofi) ![Chat](https://img.shields.io/matrix/neovim-orgmode:matrix.org?logo=matrix&server_fqdn=matrix.org&style=flat-square) - -Orgmode clone written in Lua for Neovim 0.9.2+ - -[Setup](#setup) • [Docs](/DOCS.md) • [Showcase](#showcase) • [Treesitter](#treesitter-info) • [Troubleshoot](#troubleshoot) • [Plugins](#plugins) • [Contributing](CONTRIBUTING.md) • [Kudos](#thanks-to) - -
- -## Quickstart - -### Requirements - -- Neovim 0.9.2 or later - -### Installation - -Use your favourite package manager: - -
- lazy.nvim (recommended) -
- -```lua -{ - 'nvim-orgmode/orgmode', - event = 'VeryLazy', - ft = { 'org' }, - config = function() - -- Setup orgmode - require('orgmode').setup({ - org_agenda_files = '~/orgfiles/**/*', - org_default_notes_file = '~/orgfiles/refile.org', - }) - - -- NOTE: If you are using nvim-treesitter with `ensure_installed = "all"` option - -- add `org` to ignore_install - -- require('nvim-treesitter.configs').setup({ - -- ensure_installed = 'all', - -- ignore_install = { 'org' }, - -- }) - end, -} -``` - -
- -
- packer.nvim -
- -```lua -use {'nvim-orgmode/orgmode', config = function() - require('orgmode').setup{} -end -} -``` - -
- -
- vim-plug -
- -```vim -Plug 'nvim-orgmode/orgmode' -``` - -
- -
- dein.vim -
- -```vim -call dein#add('nvim-orgmode/orgmode') -``` - -
- -### Setup - -Note that this setup is not needed for [lazy.nvim](https://github.com/folke/lazy.nvim) -since instructions above covers full setup - -````lua --- init.lua - -require('orgmode').setup({ - org_agenda_files = {'~/Dropbox/org/*', '~/my-orgs/**/*'}, - org_default_notes_file = '~/Dropbox/org/refile.org', -}) - --- NOTE: If you are using nvim-treesitter with `ensure_installed = "all"` option --- add `org` to ignore_install --- require('nvim-treesitter.configs').setup({ --- ensure_installed = 'all', --- ignore_install = { 'org' }, --- }) - -Or if you are using `init.vim`, wrap the above snippet like so: -```vim -" init.vim -lua << EOF - -require('orgmode').setup({ - org_agenda_files = {'~/Dropbox/org/*', '~/my-orgs/**/*'}, - org_default_notes_file = '~/Dropbox/org/refile.org', -}) - -EOF -```` - -#### Completion - -
- nvim-cmp -
- -```lua -require('cmp').setup({ - sources = { - { name = 'orgmode' } - } -}) -``` - -
- -
- completion-nvim -
- -```lua -vim.g.completion_chain_complete_list = { - org = { - { mode = 'omni'}, - }, -} --- add additional keyword chars -vim.cmd[[autocmd FileType org setlocal iskeyword+=:,#,+]] -``` - -
- -Or just use `omnifunc` via \\ - -### Usage - -- **Open agenda prompt**: \oa -- **Open capture prompt**: \oc -- In any orgmode buffer press g? for help - -If you are new to Orgmode, see [Getting started](/DOCS.md#getting-started-with-orgmode) section in the Docs -or a hands-on [tutorial](https://github.com/nvim-orgmode/orgmode/wiki/Getting-Started) in our wiki. - -## Showcase - -### Agenda - -![agenda](https://user-images.githubusercontent.com/1782860/123549968-8521f600-d76b-11eb-9a93-02bad08b37ce.gif) - -### Org file - -![orgfile](https://user-images.githubusercontent.com/1782860/123549982-90752180-d76b-11eb-8828-9edf9f76af08.gif) - -### Capturing and refiling - -![capture](https://user-images.githubusercontent.com/1782860/123549993-9a972000-d76b-11eb-814b-b348a93df08a.gif) - -### Autocompletion - -![autocomplete](https://user-images.githubusercontent.com/1782860/123550227-e8605800-d76c-11eb-96f6-c0a677d562d4.gif) - -## Treesitter Info - -The built-in treesitter parser is used for parsing the org files. - -### Known highlighting issues and limitations - -- LaTex is still highlighted through syntax file - -## Troubleshoot - -### Indentation is not working - -Make sure you are not overriding indentexpr in Org buffers with [nvim-treesitter indentation](https://github.com/nvim-treesitter/nvim-treesitter#indentation) - -### I get `treesitter/query.lua` errors when opening agenda/capture prompt or org files - -Tree-sitter parser might not be installed. -Try running `:lua require('orgmode.config'):reinstall_grammar()` to reinstall it. - -### Dates are not in English - -Dates are generated with Lua native date support, and it reads your current locale when creating them.
-To use different locale you can add this to your `init.lua`: - -```lua -vim.cmd('language en_US.utf8') -``` - -or `init.vim` - -``` -language en_US.utf8 -``` - -Just make sure you have `en_US` locale installed on your system. To see what you have available on the system you can -start the command `:language ` and press `` to autocomplete possible options. - -### Links are not concealed - -Links are concealed with Vim's conceal feature (see `:help conceal`). To enable concealing, add this to your `init.lua`: - -```lua -vim.opt.conceallevel = 2 -vim.opt.concealcursor = 'nc' -``` - -Or if you are using `init.vim`: - -```vim -set conceallevel=2 -set concealcursor=nc -``` - -### Jumping to file path is not working for paths with forward slash - -If you are using Windows, paths are by default written with backslashes. -To use forward slashes, you must enable `shellslash` option (see `:help 'shellslash'`). - -```lua -vim.opt.shellslash = true -``` - -Or if you are using `init.vim`: - -```vim -set shellslash -``` - -More info on issue [#281](https://github.com/nvim-orgmode/orgmode/issues/281#issuecomment-1120200775) - -## Features - -### TL;DR - -- Agenda view -- Search by tags/keyword -- Clocking time -- Repeatable dates, date and time ranges -- Capturing to default notes file/destination -- Archiving (archive file or ARCHIVE tag) -- Exporting (via `emacs`, `pandoc` and custom export options) -- Notifications (experimental, see [Issue #49](https://github.com/nvim-orgmode/orgmode/issues/49)) -- Calendar popup for easier navigation and date updates -- Various org file mappings: - - Promote/Demote - - Change TODO state - - Change dates - - Insert/Move/Refile headlines - - Change tags - - Toggle checkbox state -- Remote editing from agenda view -- Repeatable mapping via [vim-repeat](https://github.com/tpope/vim-repeat) - -### Detailed breakdown - -- Agenda prompt: - - Agenda view (a): - - Ability to show daily(vd)/weekly(vw)/monthly(vm)/yearly(vy) agenda - - Support for various date settings: - - DEADLINE: Warning settings - example: `<2021-06-11 Fri 11:00 -1d>` - - SCHEDULED: Delay setting - example: `<2021-06-11 Fri 11:00 -2d>` - - All dates - Repeater settings: - - Cumulate type: `<2021-06-11 Fri 11:00 +1w>` - - Catch-up type: `<2021-06-11 Fri 11:00 ++1w>` - - Restart type: `<2021-06-11 Fri 11:00 .+1w>` - - Time ranges - example: `<2021-06-11 Fri 11:00-12:30>` - - Date ranges - example: `<2021-06-11 Fri 11:00-12:30>--<2021-06-13 Sun 22:00>` - - Properly lists tasks according to defined dates (DEADLINE,SCHEDULED,Plain date) - - Navigate forward (f)/backward(b) or jump to specific date (J) - - Go to task under cursor in current window(\) or other window(\) - - Print category from ":CATEGORY:" property if defined - - List tasks that have "TODO" state (t): - - Find headlines matching tag(s) (m): - - Search for headlines (and it's content) for a query (s): - - [Advanced search](DOCS.md#advanced-search) for tags/todo kewords/properties - - Notifications (experimental, see [Issue #49](https://github.com/nvim-orgmode/orgmode/issues/49)) - - Clocking time -- Capture: - - Define custom templates - - Fast capturing to default notes file via \ - - Capturing to specific destination \or - - Abort capture with \ok -- Org files - - Clocking time - - Refile to destination/headline: \or - - Increase/Decrease date under cursor: \/\ - - Change date under cursor via calendar popup: cid - - Change headline TODO state: forwardcit or backwardciT - - Open hyperlink or date under cursor: \oo - - Toggle checkbox: \ - - Toggle current line to headline and vice versa: \o\* - - Toggle folding of current headline: \ - - Toggle folding in whole file: \ - - Archive headline: \o$ - - Add archive tag: \oA - - Change tags: \ot - - Promote headline: << - - Demote headline: >> - - Promote subtree: \ - - Demote subtree: \>s - - Add headline/list item/checkbox: \\ - - Insert heading after current heading and it's content: \oih - - Insert TODO heading after current line: \oiT - - Insert TODO heading after current heading and it's content: \oit - - Move headline up: \oK - - Move headline down: \oJ - - Highlighted code blocks (`#+BEGIN_SRC filetype`) - - Exporting (via `emacs`, `pandoc` and custom export options) - -Link to detailed documentation: [DOCS](DOCS.md) - -## Plugins - -- [org-roam.nvim](https://github.com/chipsenkbeil/org-roam.nvim) - Implementation of [Org-roam](https://www.orgroam.com/) knowledge management system -- [org-bullets.nvim](https://github.com/akinsho/org-bullets.nvim) - Show org mode bullets as UTF-8 characters -- [headlines.nvim](https://github.com/lukas-reineke/headlines.nvim) - Add few highlight options for code blocks and headlines -- [sniprun](https://github.com/michaelb/sniprun) - For code evaluation in blocks -- [vim-table-mode](https://github.com/dhruvasagar/vim-table-mode) - For table support - -See all available plugins on [orgmode-nvim](https://github.com/topics/orgmode-nvim) - -**If you built a plugin please add "orgmode-nvim" topic to it.** - -**NOTE**: None of the Emacs Orgmode plugins will be built into nvim-orgmode. -Anything that's a separate plugin in Emacs Orgmode should be a separate plugin in here. -The point of this plugin is to provide functionality that's built into Emacs Orgmode core, -and a good foundation for external plugins.
-If you want to build a plugin, post suggestions and improvements on [Plugins infrastructure](https://github.com/nvim-orgmode/orgmode/issues/26) -issue. - -### :wrench: API - -Documentation for our work-in-progress API can be found [here](doc/orgmode_api.txt) - -## Contributing - -See [CONTRIBUTING.md](CONTRIBUTING.md) - -## Documentation - -If you are just starting out with orgmode, have a look at the [Getting Started](https://github.com/nvim-orgmode/orgmode/wiki/Getting-Started) section in our wiki. - -Vim documentation is auto generated from [DOCS.md](DOCS.md) file with [md2vim](https://github.com/FooSoft/md2vim). - -Hosted documentation is on: [https://nvim-orgmode.github.io/](https://nvim-orgmode.github.io/) - -## Roadmap - -- [x] Support searching by properties -- [ ] Improve checkbox hierarchy -- [x] Support todo keyword faces -- [x] Support clocking work time -- [x] Improve folding -- [x] Support exporting (via existing emacs tools) -- [ ] Support archiving to specific headline -- [x] Support tables -- [ ] Support diary format dates -- [ ] Support evaluating code blocks - -## Thanks to - -- [@dhruvasagar](https://github.com/dhruvasagar) and his [vim-dotoo](https://github.com/dhruvasagar/vim-dotoo) plugin - that got me started using orgmode. Without him this plugin would not happen. -- [@milisims](https://github.com/milisims) for writing a treesitter parser for org -- [vim-orgmode](https://github.com/jceb/vim-orgmode) for some parts of the code (mostly syntax) diff --git a/README.org b/README.org new file mode 100644 index 000000000..04b85e29a --- /dev/null +++ b/README.org @@ -0,0 +1,387 @@ +#+HTML:
+ +#+HTML: A blend of the Neovim (shape) and Org-mode (colours) logos
+ +* nvim-orgmode + +#+HTML:License +#+HTML:Kofi +#+HTML:Chat + +Orgmode clone written in Lua for Neovim 0.9.2+ + +[[#setup][Setup]] • [[/DOCS.md][Docs]] • [[#showcase][Showcase]] • [[#treesitter-info][Treesitter]] • [[#troubleshoot][Troubleshoot]] • [[#plugins][Plugins]] • [[CONTRIBUTING.md][Contributing]] • [[#thanks-to][Kudos]] + +#+HTML:
+ + +** Quickstart + +*** Requirements + +- Neovim 0.9.2 or later + +*** Installation + +Use your favourite package manager: + +#+HTML:
lazy.nvim (recommended)
+ +#+BEGIN_SRC lua +{ + 'nvim-orgmode/orgmode', + event = 'VeryLazy', + ft = { 'org' }, + config = function() + -- Setup orgmode + require('orgmode').setup({ + org_agenda_files = '~/orgfiles/**/*', + org_default_notes_file = '~/orgfiles/refile.org', + }) + + -- NOTE: If you are using nvim-treesitter with ~ensure_installed = "all"~ option + -- add ~org~ to ignore_install + -- require('nvim-treesitter.configs').setup({ + -- ensure_installed = 'all', + -- ignore_install = { 'org' }, + -- }) + end, +} +#+END_SRC + +#+HTML:
+ +#+HTML:
packer.nvim
+ +#+BEGIN_SRC lua +use {'nvim-orgmode/orgmode', config = function() + require('orgmode').setup{} +end +} +#+END_SRC + +#+HTML:
+ +#+HTML:
vim-plug
+ +#+BEGIN_SRC vim +Plug 'nvim-orgmode/orgmode' +#+END_SRC + +#+HTML:
+ +#+HTML:
dein.vim
+ +#+BEGIN_SRC vim +call dein#add('nvim-orgmode/orgmode') +#+END_SRC + +#+HTML:
+ +*** Setup + +Note that this setup is not needed for [[https://github.com/folke/lazy.nvim][lazy.nvim]] +since instructions above covers full setup + +#+BEGIN_SRC lua +-- init.lua + +require('orgmode').setup({ + org_agenda_files = {'~/Dropbox/org/*', '~/my-orgs/**/*'}, + org_default_notes_file = '~/Dropbox/org/refile.org', +}) + +-- NOTE: If you are using nvim-treesitter with ~ensure_installed = "all"~ option +-- add ~org~ to ignore_install +-- require('nvim-treesitter.configs').setup({ +-- ensure_installed = 'all', +-- ignore_install = { 'org' }, +-- }) + +Or if you are using ~init.vim~, wrap the above snippet like so: +#+BEGIN_SRC vim +" init.vim +lua << EOF + +require('orgmode').setup({ + org_agenda_files = {'~/Dropbox/org/*', '~/my-orgs/**/*'}, + org_default_notes_file = '~/Dropbox/org/refile.org', +}) + +EOF +#+END_SRC + +**** Completion + +#+HTML:
nvim-cmp
+#+BEGIN_SRC lua +require('cmp').setup({ + sources = { + { name = 'orgmode' } + } +}) +#+END_SRC + +#+HTML:
+ +#+HTML:
completion-nvim
+ +#+BEGIN_SRC lua +vim.g.completion_chain_complete_list = { + org = { + { mode = 'omni'}, + }, +} +-- add additional keyword chars +vim.cmd[[autocmd FileType org setlocal iskeyword+=:,#,+]] +#+END_SRC + +#+HTML:
+ +Or just use ~omnifunc~ via == + +*** Usage + +- *Open agenda prompt*: =oa= +- *Open capture prompt*: =oc= +- In any orgmode buffer press =g?= for help + +If you are new to Orgmode, see [[/DOCS.md#getting-started-with-orgmode][Getting started]] section in the Docs +or a hands-on [[https://github.com/nvim-orgmode/orgmode/wiki/Getting-Started][tutorial]] in our wiki. + +** Showcase + +*** Agenda + +#+CAPTION: agenda +#+NAME: agenda +[[https://user-images.githubusercontent.com/1782860/123549968-8521f600-d76b-11eb-9a93-02bad08b37ce.gif]] + +*** Org file + +#+CAPTION: orgfile +#+NAME: orgfile +[[https://user-images.githubusercontent.com/1782860/123549982-90752180-d76b-11eb-8828-9edf9f76af08.gif]] + +*** Capturing and refiling + +#+CAPTION: capture +#+NAME: capture +[[https://user-images.githubusercontent.com/1782860/123549993-9a972000-d76b-11eb-814b-b348a93df08a.gif]] + +*** Autocompletion + +#+CAPTION: autocomplete +#+NAME: autocomplete +[[https://user-images.githubusercontent.com/1782860/123550227-e8605800-d76c-11eb-96f6-c0a677d562d4.gif]] + +** Treesitter Info + +The built-in treesitter parser is used for parsing the org files. + +*** Known highlighting issues and limitations + +- LaTex is still highlighted through syntax file + +** Troubleshoot + +*** Indentation is not working + +Make sure you are not overriding indentexpr in Org buffers with [[https://github.com/nvim-treesitter/nvim-treesitter#indentation][nvim-treesitter indentation]] + +*** I get ~treesitter/query.lua~ errors when opening agenda/capture prompt or org files + +Tree-sitter parser might not be installed. +Try running ~:lua require('orgmode.config'):reinstall_grammar()~ to reinstall it. + +*** Dates are not in English + +Dates are generated with Lua native date support, and it reads your current locale when creating them. +#+HTML:
+To use different locale you can add this to your ~init.lua~: + +#+BEGIN_SRC lua +vim.cmd('language en_US.utf8') +#+END_SRC + +or ~init.vim~ + +#+BEGIN_SRC vim +language en_US.utf8 +#+END_SRC + +Just make sure you have ~en_US~ locale installed on your system. To see what you have available on the system you can +start the command ~:language~ and press ~~ to autocomplete possible options. + +*** Links are not concealed + +Links are concealed with Vim's conceal feature (see ~:help conceal~). To enable concealing, add this to your ~init.lua~: + +#+BEGIN_SRC lua +vim.opt.conceallevel = 2 +vim.opt.concealcursor = 'nc' +#+END_SRC + +Or if you are using ~init.vim~: + +#+BEGIN_SRC vim +set conceallevel=2 +set concealcursor=nc +#+END_SRC + +*** Jumping to file path is not working for paths with forward slash + +If you are using Windows, paths are by default written with backslashes. +To use forward slashes, you must enable ~shellslash~ option +(see ~:help shellslash~). + +#+BEGIN_SRC lua +vim.opt.shellslash = true +#+END_SRC + +Or if you are using ~init.vim~: + +#+BEGIN_SRC vim +set shellslash +#+END_SRC + +More info on issue [[https://github.com/nvim-orgmode/orgmode/issues/281#issuecomment-1120200775][#281]] + +** Features + +*** TL;DR + +- Agenda view +- Search by tags/keyword +- Clocking time +- Repeatable dates, date and time ranges +- Capturing to default notes file/destination +- Archiving (archive file or ARCHIVE tag) +- Exporting (via ~emacs~, ~pandoc~ and custom export options) +- Notifications (experimental, see [[https://github.com/nvim-orgmode/orgmode/issues/49)][Issue #49]] +- Calendar popup for easier navigation and date updates +- Various org file mappings: + - Promote/Demote + - Change TODO state + - Change dates + - Insert/Move/Refile headlines + - Change tags + - Toggle checkbox state +- Remote editing from agenda view +- Repeatable mapping via [[https://github.com/tpope/vim-repeat][vim-repeat]] + +*** Detailed breakdown + +- Agenda prompt: + - Agenda view (=a=): + - Ability to show daily(=vd=)/weekly(=vw=)/monthly(=vm=)/yearly(=vy=) agenda + - Support for various date settings: + - DEADLINE: Warning settings - example: ~<2021-06-11 Fri 11:00 -1d>~ + - SCHEDULED: Delay setting - example: ~<2021-06-11 Fri 11:00 -2d>~ + - All dates - Repeater settings: + - Cumulate type: ~<2021-06-11 Fri 11:00 +1w>~ + - Catch-up type: ~<2021-06-11 Fri 11:00 ++1w>~ + - Restart type: ~<2021-06-11 Fri 11:00 .+1w>~ + - Time ranges - example: ~<2021-06-11 Fri 11:00-12:30>~ + - Date ranges - example: ~<2021-06-11 Fri 11:00-12:30>--<2021-06-13 Sun 22:00>~ + - Properly lists tasks according to defined dates (DEADLINE,SCHEDULED,Plain date) + - Navigate forward (=f=)/backward(=b=) or jump to specific date (=J=) + - Go to task under cursor in current window(==) or other window(==) + - Print category from ":CATEGORY:" property if defined + - List tasks that have "TODO" state (=t=): + - Find headlines matching tag(s) (=m=): + - Search for headlines (and it's content) for a query (=s=): + - [[DOCS.md#advanced-search][Advanced search]] for tags/todo kewords/properties + - Notifications (experimental, see [[https://github.com/nvim-orgmode/orgmode/issues/49)][Issue #49]] + - Clocking time +- Capture: + - Define custom templates + - Fast capturing to default notes file via == + - Capturing to specific destination =or= + - Abort capture with =ok= +- Org files + - Clocking time + - Refile to destination/headline: =or= + - Increase/Decrease date under cursor: == / == + - Change date under cursor via calendar popup: =cid= + - Change headline TODO state: forward =cit= or backward =ciT= + - Open hyperlink or date under cursor: =oo= + - Toggle checkbox: == + - Toggle current line to headline and vice versa: =o*= + - Toggle folding of current headline: == + - Toggle folding in whole file: == + - Archive headline: =o$= + - Add archive tag: =oA= + - Change tags: =ot= + - Promote headline: =<<= + - Demote headline: =>>= + - Promote subtree: =s= + - Add headline/list item/checkbox: == + - Insert heading after current heading and it's content: =oih= + - Insert TODO heading after current line: =oiT= + - Insert TODO heading after current heading and it's content: =oit= + - Move headline up: =oK= + - Move headline down: =oJ= + - Highlighted code blocks (~#+BEGIN_SRC filetype~) + Exporting (via ~emacs~, ~pandoc~ and custom export options) + +Link to detailed documentation: [[DOCS.md][DOCS]] + +** Plugins + +- [[https://github.com/chipsenkbeil/org-roam.nvim][org-roam.nvim]] - Implementation of [[https://orgroam.com][Org-roam]] knowledge management system +- [[https://github.com/akinsho/org-bullets.nvim][org-bullets.nvim]] - Show org mode bullets as UTF-8 characters +- [[https://github.com/lukas-reineke/headlines.nvim][headlines.nvim]] - Add few highlight options for code blocks and headlines +- [[https://github.com/michaelb/sniprun][sniprun]] - For code evaluation in blocks +- [[https://github.com/dhruvasagar/vim-table-mode][vim-table-mode]] - For table support + +See all available plugins on [[https://github.com/topics/orgmode-nvim][orgmode-nvim]] + +*If you built a plugin please add "orgmode-nvim" topic to it.* + +#+BEGIN_QUOTE +*NOTE*: None of the Emacs Orgmode plugins will be built into nvim-orgmode. +Anything that's a separate plugin in Emacs Orgmode should be a separate plugin in here. +The point of this plugin is to provide functionality that's built into Emacs Orgmode core, +and a good foundation for external plugins. +#+END_QUOTE + +If you want to build a plugin, post suggestions and improvements on [[https://github.com/nvim-orgmode/orgmode/issues/26][Plugins infrastructure]] +issue. + +*** :wrench: API + +Documentation for our work-in-progress API can be found [[doc/orgmode_api.txt][here]] + +** Contributing + +See [[CONTRIBUTING.md][CONTRIBUTING.md]] + +** Documentation + +If you are just starting out with orgmode, have a look at the [[https://github.com/nvim-orgmode/orgmode/wiki/Getting-Started][Getting Started]] section in our wiki. + +Vim documentation is auto generated from [[DOCS.md][DOCS.md]] file with [[https://github.com/FooSoft/md2vim][md2vim]]. + +Hosted documentation is on: [[https://nvim-orgmode.github.io/][https://nvim-orgmode.github.io/]] + +** Roadmap + +- :white_check_mark: Support searching by properties +- :white_square_button: Improve checkbox hierarchy +- :white_check_mark: Support todo keyword faces +- :white_check_mark: Support clocking work time +- :white_check_mark: Improve folding +- :white_check_mark: Support exporting (via existing emacs tools) +- :white_square_button: Support archiving to specific headline +- :white_check_mark: Support tables +- :white_square_button: Support diary format dates +- :white_square_button: Support evaluating code blocks + +** Thanks to + +- [[https://github.com/dhruvasagar][@dhruvasagar]] and his [[https://github.com/dhruvasagar/vim-dotoo][vim-dotoo]] plugin + that got me started using orgmode. Without him this plugin would not happen. +- [[https://github.com/milisims][@milisims]] for writing a treesitter parser for org +- [[https://github.com/jceb/vim-orgmode][vim-orgmode]] for some parts of the code (mostly syntax)