File tree 1 file changed +40
-0
lines changed
1 file changed +40
-0
lines changed Original file line number Diff line number Diff line change 1
1
# Nvim Orgmode Docs
2
+
3
+ Documentation for [ nvim-orgmode] ( https://github.com/nvim-orgmode/orgmode )
4
+
5
+
6
+ ## How to contribute
7
+ All documentation is in rst format inside ` docs/ ` folder.
8
+ Once the docs are merged into the ` main ` branch Github Action deploys it to ` gh-pages ` branch automatically
9
+
10
+
11
+ ## View documentation locally
12
+
13
+ To preview documentation locally, few dependencies needs to be installed:
14
+
15
+ ### Dependencies
16
+ Ubuntu:
17
+ ```
18
+ sudo apt-get install -y python3-sphinx python3-sphinx-rtd-theme
19
+ ```
20
+
21
+ Arch:
22
+ ```
23
+ sudo pacman -S python-sphinx python-sphinx_rtd_theme
24
+ ```
25
+
26
+ For other platforms, see [ Getting started with sphinx] ( https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html ) .
27
+
28
+ ### Build
29
+
30
+ To build the documentation, go into the ` docs/ ` folder and run ` make html ` :
31
+
32
+ ```
33
+ cd docs/
34
+ make html
35
+ ```
36
+
37
+ This will generate ` _build ` folder inside the ` docs/ ` , and you can just open it up:
38
+
39
+ ```
40
+ xdg-open _/build/html/index.html
41
+ ```
You can’t perform that action at this time.
0 commit comments