Skip to content

Commit b3aa676

Browse files
Add getting started section to docs.
1 parent e560124 commit b3aa676

File tree

3 files changed

+192
-173
lines changed

3 files changed

+192
-173
lines changed

DOCS.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,32 @@
11
# Table of content
22

3-
1. [Settings](#settings)
3+
1. [Getting started with Orgmode](#getting-started-with-orgmode)
4+
2. [Settings](#settings)
45
1. [Global settings](#global-settings)
56
2. [Agenda settings](#global-settings)
67
3. [Tags settings](#global-settings)
7-
2. [Mappings](#mappings)
8+
3. [Mappings](#mappings)
89
1. [Global mappings](#global-mappings)
910
2. [Agenda mappings](#agenda-mappings)
1011
3. [Capture mappings](#capture-mappings)
1112
4. [Org mappings](#org-mappings)
1213
5. [Edit Src mappings](#edit-src)
1314
6. [Text objects](#text-objects)
1415
7. [Dot repeat](#dot-repeat)
15-
3. [Document Diagnostics](#document-diagnostics)
16-
4. [Autocompletion](#autocompletion)
17-
5. [Abbreviations](#abbreviations)
18-
6. [Colors](#colors)
19-
7. [Advanced search](#advanced-search)
20-
8. [Notifications (experimental)](#notifications-experimental)
21-
9. [Clocking](#clocking)
22-
10. [Changelog](#changelog)
16+
4. [Document Diagnostics](#document-diagnostics)
17+
5. [Autocompletion](#autocompletion)
18+
6. [Abbreviations](#abbreviations)
19+
7. [Colors](#colors)
20+
8. [Advanced search](#advanced-search)
21+
9. [Notifications (experimental)](#notifications-experimental)
22+
10. [Clocking](#clocking)
23+
11. [Changelog](#changelog)
24+
25+
## Getting started with Orgmode
26+
To get a basic idea how Orgmode works, look at this screencast from [@dhruvasagar](https://github.com/dhruvasagar)
27+
that demonstrates how the similar Orgmode clone [vim-dotoo](https://github.com/dhruvasagar/vim-dotoo) works.
28+
29+
[https://www.youtube.com/watch?v=nsv33iOnH34](https://www.youtube.com/watch?v=nsv33iOnH34)
2330

2431
## Settings
2532
Variable names mostly follow the same naming as Orgmode mappings.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,8 @@ EOF
132132
* **Open capture prompt**: <kbd>\<Leader\>oc</kbd>
133133
* In any orgmode buffer press <kbd>g?</kbd> for help
134134

135+
If you are new to Orgmode, see [Getting started](/DOCS.md#getting-started-with-orgmode) section in Docs.
136+
135137
### Completion
136138
If you use [nvim-compe](https://github.com/hrsh7th/nvim-compe) and want
137139
to enable autocompletion, add this to your compe config:

0 commit comments

Comments
 (0)