https://github.com/nvim-orgmode/nvim-orgmode.github.io

Documentation
https://github.com/nvim-orgmode/nvim-orgmode.github.io

Last synced: about 1 month ago
JSON representation

Documentation

• Host: GitHub
• URL: https://github.com/nvim-orgmode/nvim-orgmode.github.io
• Owner: nvim-orgmode
• License: mit
• Created: 2022-04-24T14:00:14.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-05-01T19:57:32.000Z (over 2 years ago)
• Last Synced: 2023-03-03T23:24:52.024Z (almost 2 years ago)
• Size: 4.98 MB
• Stars: 1
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nvim Orgmode Docs

Documentation for [nvim-orgmode](https://github.com/nvim-orgmode/orgmode)

## How to contribute

All documentation is in rst format inside `docs/` folder.

Once the docs are merged into the `main` branch Github Action deploys it to `gh-pages` branch automatically

## View documentation locally

To preview documentation locally, few dependencies needs to be installed:

### Dependencies

Ubuntu:

```

sudo apt-get install -y python3-sphinx python3-sphinx-rtd-theme

```

Arch:

```

sudo pacman -S python-sphinx python-sphinx_rtd_theme

```

For other platforms, see [Getting started with sphinx](https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html).

### Build

To build the documentation, go into the `docs/` folder and run `make html`:

```

cd docs/

make html

```

This will generate `_build` folder inside the `docs/`, and you can just open it up:

```

xdg-open _/build/html/index.html

```