Skip to content

Commit

Permalink
Add getting started section to docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
kristijanhusak committed Dec 12, 2021
1 parent e560124 commit b3aa676
Show file tree
Hide file tree
Showing 3 changed files with 192 additions and 173 deletions.
27 changes: 17 additions & 10 deletions DOCS.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,32 @@
# Table of content

1. [Settings](#settings)
1. [Getting started with Orgmode](#getting-started-with-orgmode)
2. [Settings](#settings)
1. [Global settings](#global-settings)
2. [Agenda settings](#global-settings)
3. [Tags settings](#global-settings)
2. [Mappings](#mappings)
3. [Mappings](#mappings)
1. [Global mappings](#global-mappings)
2. [Agenda mappings](#agenda-mappings)
3. [Capture mappings](#capture-mappings)
4. [Org mappings](#org-mappings)
5. [Edit Src mappings](#edit-src)
6. [Text objects](#text-objects)
7. [Dot repeat](#dot-repeat)
3. [Document Diagnostics](#document-diagnostics)
4. [Autocompletion](#autocompletion)
5. [Abbreviations](#abbreviations)
6. [Colors](#colors)
7. [Advanced search](#advanced-search)
8. [Notifications (experimental)](#notifications-experimental)
9. [Clocking](#clocking)
10. [Changelog](#changelog)
4. [Document Diagnostics](#document-diagnostics)
5. [Autocompletion](#autocompletion)
6. [Abbreviations](#abbreviations)
7. [Colors](#colors)
8. [Advanced search](#advanced-search)
9. [Notifications (experimental)](#notifications-experimental)
10. [Clocking](#clocking)
11. [Changelog](#changelog)

## Getting started with Orgmode
To get a basic idea how Orgmode works, look at this screencast from [@dhruvasagar](https://github.com/dhruvasagar)
that demonstrates how the similar Orgmode clone [vim-dotoo](https://github.com/dhruvasagar/vim-dotoo) works.

[https://www.youtube.com/watch?v=nsv33iOnH34](https://www.youtube.com/watch?v=nsv33iOnH34)

## Settings
Variable names mostly follow the same naming as Orgmode mappings.
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,8 @@ EOF
* **Open capture prompt**: <kbd>\<Leader\>oc</kbd>
* In any orgmode buffer press <kbd>g?</kbd> for help

If you are new to Orgmode, see [Getting started](/DOCS.md#getting-started-with-orgmode) section in Docs.

### Completion
If you use [nvim-compe](https://github.com/hrsh7th/nvim-compe) and want
to enable autocompletion, add this to your compe config:
Expand Down
Loading

0 comments on commit b3aa676

Please sign in to comment.