Auto generate docs
This commit is contained in:
parent
22adcf0fb8
commit
dd473593d5
1 changed files with 1 additions and 51 deletions
|
|
@ -1,4 +1,4 @@
|
||||||
*orgmode-babel.nvim.txt* For NVIM v0.9.0 Last change: 2023 June 27
|
*orgmode-babel.nvim.txt* For NVIM v0.9.0 Last change: 2023 June 30
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
Table of Contents *orgmode-babel.nvim-table-of-contents*
|
Table of Contents *orgmode-babel.nvim-table-of-contents*
|
||||||
|
|
@ -7,7 +7,6 @@ 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*
|
||||||
|
|
@ -89,55 +88,6 @@ 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 be sourced during execution of `:OrgExecute` and
|
|
||||||
`:OrgTangle`, so packages you install there that provide extra babel languages
|
|
||||||
will be available!
|
|
||||||
|
|
||||||
Follow the package's installation steps, and if they tell you to include it in
|
|
||||||
`org-babel-load-languages`, additionally make sure that you include it in
|
|
||||||
`opts.langs`.
|
|
||||||
|
|
||||||
1. Example
|
|
||||||
|
|
||||||
As an example, lets add ob-mermaid <https://github.com/arnm/ob-mermaid> for
|
|
||||||
mermaid functionality in `orgmode-babel.nvim`!
|
|
||||||
|
|
||||||
First, lets create a `~/.emacs.d/init.el`.
|
|
||||||
|
|
||||||
>
|
|
||||||
; ~/.emacs.d/init.el
|
|
||||||
|
|
||||||
; Add the melpa package manager
|
|
||||||
(require 'package)
|
|
||||||
(add-to-list 'package-archives
|
|
||||||
'("melpa" . "https://melpa.org/packages/") t)
|
|
||||||
(package-initialize)
|
|
||||||
|
|
||||||
; Install ob-mermaid
|
|
||||||
(unless (package-installed-p 'ob-mermaid)
|
|
||||||
(package-install 'ob-mermaid))
|
|
||||||
<
|
|
||||||
|
|
||||||
Then, in our plugin configuration, we can add `mermaid` to our `opts.langs`.
|
|
||||||
|
|
||||||
>lua
|
|
||||||
{
|
|
||||||
"mrshmllow/orgmode-babel.nvim",
|
|
||||||
...
|
|
||||||
opts = {
|
|
||||||
langs = { ..., "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:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue