Auto generate docs

This commit is contained in:
mrshmllow 2023-06-30 04:55:19 +00:00 committed by github-actions[bot]
parent d38c691151
commit f0d8aa0fd7

View file

@ -7,6 +7,7 @@ Table of Contents *orgmode-babel.nvim-table-of-contents*
- Requirements |orgmode-babel.nvim-orgmode-babel.nvim-requirements| - Requirements |orgmode-babel.nvim-orgmode-babel.nvim-requirements|
- Setup |orgmode-babel.nvim-orgmode-babel.nvim-setup| - Setup |orgmode-babel.nvim-orgmode-babel.nvim-setup|
- Usage |orgmode-babel.nvim-orgmode-babel.nvim-usage| - Usage |orgmode-babel.nvim-orgmode-babel.nvim-usage|
- Advanced Configuration|orgmode-babel.nvim-orgmode-babel.nvim-advanced-configuration|
============================================================================== ==============================================================================
1. orgmode-babel.nvim *orgmode-babel.nvim-orgmode-babel.nvim* 1. orgmode-babel.nvim *orgmode-babel.nvim-orgmode-babel.nvim*
@ -46,6 +47,9 @@ LAZY.NVIM ~
opts = { opts = {
-- by default, none are enabled -- by default, none are enabled
langs = { "python", "lua", ... } langs = { "python", "lua", ... }
-- paths to emacs packages to additionally load
load_paths = {}
} }
}, },
< <
@ -88,6 +92,45 @@ Tangles all blocks in range. If the range is NOT `%`, the tangled file will
likely only contain the contents of the last block, which is expected likely only contain the contents of the last block, which is expected
behaviour. behaviour.
ADVANCED CONFIGURATION*orgmode-babel.nvim-orgmode-babel.nvim-advanced-configuration*
ADDING EXTRA ORG-MODE LANGUAGES ~
Your emacs `init.el` will **not** be sourced during execution of `:OrgExecute`
and `:OrgTangle`, so packages you install there wont be available.
However, `orgmode-babel.nvim` allows us to specify extra load paths, so we can
make packages available that way.
1. Example
As an example, lets add ob-mermaid <https://github.com/arnm/ob-mermaid> for
mermaid functionality in `orgmode-babel.nvim`!
We have two options to get the package. We could either create an
`~/.emacs.d/init.el` and install it through a package manager, which will
likely have a randomish name, or for the sake of simplicity and this being a
neovim plugin, we can simply manually clone the repo to a known location.
>example
git clone https://github.com/arnm/ob-mermaid ~/.../clone-location/ob-mermaid
<
>lua
{
"mrshmllow/orgmode-babel.nvim",
...
opts = {
langs = { ..., "mermaid" }
load_paths = { "~/.../clone-location/ob-mermaid" }
}
},
<
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc> Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
vim:tw=78:ts=8:noet:ft=help:norl: vim:tw=78:ts=8:noet:ft=help:norl: