RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://nvim-orgmode.github.io below:

Website Navigation

Home

Nvim Orgmode

Nvim orgmode is a clone of Emacs Orgmode for Neovim 0.10.3+. It aims to be a feature-complete implementation of Orgmode features in Neovim.

Online version of this documentation is available at https://nvim-orgmode.github.io.

To view this documentation offline in Neovim, run :Org help. More info in Globals and commands section.

Quick start

Install with lazy.nvim:

lua

{
  'nvim-orgmode/orgmode',
  event = 'VeryLazy',
  config = function()
    -- Setup orgmode
    require('orgmode').setup({
      org_agenda_files = '~/orgfiles/**/*',
      org_default_notes_file = '~/orgfiles/refile.org',
    })
  end,
}

Capture your first note with <leader>oc
Open up the prompt for agenda with <leader>oa

For more details about the installation and usage, check Installation page.

To see all configuration options, check Configuration page.

Getting started with orgmode

To get a basic idea how Orgmode works, check our hands-on tutorial.

You can also check this screencast from @dhruvasagar that demonstrates how the similar Orgmode clone vim-dotoo works.

https://www.youtube.com/watch?v=nsv33iOnH34

API docs

Nvim-orgmode exposes a Lua API that can be used to interact with the orgmode. To view it, check orgmode_api.txt or do :h OrgApi in Neovim.

Globals and commands

There are 2 additional ways to interact with Orgmode:

Through the :Org command
Through Org Lua global variable

List of available actions:

:Org help - Open this documentation in new tab, set working directory to the docs folder for the tab to allow browsing
:Org helpgrep - Open search agenda view that allows searching through the documentation
:Org agenda {type?} - Open agenda view by the shortcut, for example :Org agenda M will open tags_todo view. When type is omitted, it opens up Agenda view.
:Org capture {type?} - Open capture template by the shortcut, for example :Org capture t. When type is omitted, it opens up Capture prompt.
:Org install_treesitter_grammar - Install the treesitter grammar for Orgmode. If installed, prompt to reinstall. Grammar is installed automatically on first run, but this is useful in case when there are issues with the grammar.
:Org store_link - Store link to the headline under cursor. Works in both agenda and org files.
:Org indent_mode - Toggle virtual indent mode in the current buffer. See osg_startup_indented for additional info.

All of the commands above can be executed through the global Lua Org variable. Examples:

Org.help()
Org.helpgrep()
Org.install_treesitter_grammar()
Org.store_link()
Org.indent_mode()
Org.agenda() - Opens agenda prompt
Org.agenda.m() - Opens tags view
Org.capture() - Opens capture prompt
Org.capture.t() - Opens capture template for t shortcut

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4