Merge pull request #1 from gerazov/read-the-docs-init

Author: kristijanhusak

.gitignore

@@ -0,0 +1 @@
+docs_rst/_build

docs/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 94d52713906d860f46fc35a9a963f271
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/.nojekyll

@@ -0,0 +1,30 @@
+Demos
+==========
+Agenda
+********************************
+
+.. raw:: html
+
+  <img alt="agenda" src="https://user-images.githubusercontent.com/1782860/123549968-8521f600-d76b-11eb-9a93-02bad08b37ce.gif" />
+
+Org file
+********************************
+
+.. raw:: html
+
+  <img alt="orgfile" src="https://user-images.githubusercontent.com/1782860/123549982-90752180-d76b-11eb-8828-9edf9f76af08.gif" />
+
+Capturing and refiling
+********************************
+
+.. raw:: html
+
+  <img alt="capture" src="https://user-images.githubusercontent.com/1782860/123549993-9a972000-d76b-11eb-814b-b348a93df08a.gif" />
+
+Autocompletion
+********************************
+
+.. raw:: html
+
+  <img alt="autocomplete" src="https://user-images.githubusercontent.com/1782860/123550227-e8605800-d76c-11eb-96f6-c0a677d562d4.gif" />
+

docs/_sources/demo.rst.txt

@@ -0,0 +1,29 @@
+Development
+========================================
+
+Tests
+************
+
+To run tests, `plenary.nvim <https://github.com/nvim-lua/plenary.nvim>`_ is necessary. Once installed, run:
+
+.. code-block:: bash
+
+    make test
+
+Documentation
+*************
+
+Vim documentation is auto generated from `DOCS.md <DOCS.md>`_ file with `md2vim <https://github.com/FooSoft/md2vim>`_.
+
+Formatting
+************
+Formatting is done via `StyLua <https://github.com/JohnnyMorganz/StyLua>`_. To format everything run:
+
+.. code-block:: bash
+
+    make format
+
+Parser
+************
+Parsing is done via builtin tree-sitter parser and `tree-sitter-org <https://github.com/milisims/tree-sitter-org>`_ grammar.
+

docs/_sources/development.rst.txt

@@ -0,0 +1,94 @@
+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
+
+* Clocking time
+* 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(``<CR>``) or other window(``<TAB>``)
+    * 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 ``<C-c>``
+  * Capturing to specific destination ``<Leader>or``
+  * Abort capture with ``<Leader>ok``
+
+* Org files
+
+  * Clocking time
+  * Refile to destination/headline: ``<Leader>or``
+  * Increase/Decrease date under cursor: ``<C-a>``/``<C-x>``
+  * Change date under cursor via calendar popup: ``cid``
+  * Change headline TODO state: forward``cit`` or backward``ciT``
+  * Open hyperlink or date under cursor: ``<Leader>oo``
+  * Toggle checkbox: ``<C-space>``
+  * Toggle current line to headline and vice versa: ``<Leader>o*``
+  * Toggle folding of current headline: ``<TAB>``
+  * Toggle folding in whole file: ``<S-TAB>``
+  * Archive headline: ``<Leader>o$``
+  * Add archive tag: ``<Leader>oA``
+  * Change tags: ``<Leader>ot``
+  * Promote headline: ``<<``
+  * Demote headline: ``>>``
+  * Promote subtree: ``<s``
+  * Demote subtree: ``>s``
+  * Add headline/list item/checkbox: ``<Leader><CR>``
+  * Insert heading after current heading and it's content: ``<Leader>oih``
+  * Insert TODO heading after current line: ``<Leader>oiT``
+  * Insert TODO heading after current heading and it's content: ``<Leader>oit``
+  * Move headline up: ``<Leader>oK``
+  * Move headline down: ``<Leader>oJ``
+  * Highlighted code blocks (`#+BEGIN_SRC filetype`)
+  * Exporting (via ``emacs``, ``pandoc`` and custom export options)
+
+Link to detailed documentation: `DOCS <https://github.com/nvim-orgmode/orgmode/blob/master/DOCS.md>`_

docs/_sources/features.rst.txt

@@ -0,0 +1,24 @@
+Getting started
+========================================
+This chapter will show you the basics of using orgmode to organise your tasks.
+
+Creating TODO items
+***********************************************
+
+Defining and moving TODO items between states
+***********************************************
+
+Adding dates to TODO items
+***********************************************
+
+Viewing scheduled TODO items
+***********************************************
+
+Adding a priority to TODO items
+***********************************************
+
+Capturing a TODO item
+***********************************************
+
+Refiling a TODO item
+***********************************************

docs/_sources/getting_started.rst.txt

@@ -0,0 +1,33 @@
+.. raw:: html
+
+    <div align="center">
+        <img alt="org-neovim-blend" src="https://user-images.githubusercontent.com/1782860/124820564-eddc5000-df6d-11eb-9016-d0c073a9575c.png" width="250" />
+    </div>
+
+Orgmode.nvim
+============
+
+.. raw:: html
+
+    <div align="left">
+        <a href="/LICENSE"><img alt="License" src="https://img.shields.io/badge/license-MIT-brightgreen?style=flat-square"</a><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>
+        <p>
+    </div>
+
+
+Orgmode clone written in Lua for Neovim 0.7.
+
+
+.. toctree::
+   :maxdepth: 1
+
+   getting_started 
+   installation
+   setup
+   features
+   demo
+   plugins
+   development
+   roadmap
+   thanks
+

docs/_sources/index.rst.txt

@@ -0,0 +1,58 @@
+Installation
+============
+
+Use your favourite package manager:
+
+* `vim-packager <https://github.com/kristijanhusak/vim-packager>`_:
+
+
+.. code-block:: lua
+
+    packager.add('nvim-treesitter/nvim-treesitter')
+    packager.add('nvim-orgmode/orgmode')
+
+- `packer.nvim <https://github.com/wbthomason/packer.nvim>`_
+
+**Recommended**
+
+
+.. code-block:: lua
+
+    use {'nvim-treesitter/nvim-treesitter'}
+    use {'nvim-orgmode/orgmode', config = function()
+            require('orgmode').setup{}
+    end
+    }
+
+**Lazy loading (Not recommended)**
+
+Lazy loading via ``ft`` option works, but not completely. Global mappings are not set because plugin is not initialized on startup.
+Above setup has startup time of somewhere between 1 and 3 ms, so there are no many benefits in lazy loading.
+If you want to do it anyway, here's the lazy load setup:
+
+.. code-block:: lua
+
+    use {'nvim-treesitter/nvim-treesitter'}
+    use {'nvim-orgmode/orgmode',
+        ft = {'org'},
+        config = function()
+                require('orgmode').setup{}
+        end
+        }
+
+- `vim-plug <https://github.com/junegunn/vim-plug>`_
+
+
+.. code-block:: lua
+
+    Plug 'nvim-treesitter/nvim-treesitter'
+    Plug 'nvim-orgmode/orgmode'
+
+- `dein <https://github.com/Shougo/dein.vim>`_
+
+
+.. code-block:: vim
+
+    call dein#add('nvim-treesitter/nvim-treesitter')
+    call dein#add('nvim-orgmode/orgmode')
+

docs/_sources/installation.rst.txt

@@ -0,0 +1,19 @@
+Plugins
+========================================
+* `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 orgmode.nvim.
+Anything that's a separate plugin in Emacs Orgmode should be a separate plugin in here.
+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.
+

docs/_sources/plugins.rst.txt

@@ -0,0 +1,12 @@
+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
+* [ ] Support tables
+* [ ] Support diary format dates
+* [ ] Support evaluating code blocks