Add tools for writing vim doc files
parent
7d74ece542
commit
bae6e0e441
|
|
@ -0,0 +1,2 @@
|
||||||
|
setlocal ts=2 sts=2 sw=2 expandtab autoindent
|
||||||
|
let b:undo_ftplugin .= '|setlocal ts< sts< sw< expandtab< autoindent<'
|
||||||
|
|
@ -2,6 +2,10 @@ if require('init.first_load')() then
|
||||||
return
|
return
|
||||||
end
|
end
|
||||||
|
|
||||||
|
vim.cmd [[filetype plugin on]]
|
||||||
|
vim.cmd [[filetype indent on]]
|
||||||
|
vim.cmd [[syntax on]]
|
||||||
|
|
||||||
vim.api.nvim_exec('let $OVIMHOME = $HOME."/.vim"', false)
|
vim.api.nvim_exec('let $OVIMHOME = $HOME."/.vim"', false)
|
||||||
vim.api.nvim_exec('let $VIMHOME = $HOME."/.config/nvim"', false)
|
vim.api.nvim_exec('let $VIMHOME = $HOME."/.config/nvim"', false)
|
||||||
vim.api.nvim_exec('let $NVIMHOME = $HOME."/.local/share/nvim"', false)
|
vim.api.nvim_exec('let $NVIMHOME = $HOME."/.local/share/nvim"', false)
|
||||||
|
|
|
||||||
|
|
@ -58,6 +58,7 @@ return require('packer').startup {
|
||||||
use 'vimwiki/vimwiki' -- Vimwiki - personal wiki in vim
|
use 'vimwiki/vimwiki' -- Vimwiki - personal wiki in vim
|
||||||
use 'esensar/vimwiki-reviews-lua' -- Vimwiki extension for periodic reviews
|
use 'esensar/vimwiki-reviews-lua' -- Vimwiki extension for periodic reviews
|
||||||
use 'ledger/vim-ledger' -- Support for ledger-cli format
|
use 'ledger/vim-ledger' -- Support for ledger-cli format
|
||||||
|
use 'tandrewnichols/vim-docile' -- Support for vim doc.txt format
|
||||||
|
|
||||||
-- Treesitter --
|
-- Treesitter --
|
||||||
use { --
|
use { --
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,90 @@
|
||||||
|
let g:projectionist_heuristics = {
|
||||||
|
\ "plugin/|autoload/": {
|
||||||
|
\ "doc/*.txt": {
|
||||||
|
\ "type": "help",
|
||||||
|
\ "template": [
|
||||||
|
\ "*{}.txt* Description",
|
||||||
|
\ "",
|
||||||
|
\ "INTRODUCTION *{}*",
|
||||||
|
\ "",
|
||||||
|
\ "Description",
|
||||||
|
\ "",
|
||||||
|
\ "CONTENTS *{}-contents*",
|
||||||
|
\ "",
|
||||||
|
\ " 1. Overview |{}-overview|",
|
||||||
|
\ " 2. Requirements |{}-requirements|",
|
||||||
|
\ " 3. Installation |{}-installation|",
|
||||||
|
\ " 4. Usage |{}-usage|",
|
||||||
|
\ " 5. Commands |{}-commands|",
|
||||||
|
\ " 6. Functions |{}-functions|",
|
||||||
|
\ " 7. Mappings |{}-mappings|",
|
||||||
|
\ " 8. Plugs |{}-plugs|",
|
||||||
|
\ " 9. Options |{}-options|",
|
||||||
|
\ " 10. Issues |{}-issues|",
|
||||||
|
\ " 11. Contributing |{}-contributing|",
|
||||||
|
\ " 12. Version |{}-version|",
|
||||||
|
\ " 13. License |{}-license|",
|
||||||
|
\ "",
|
||||||
|
\ "OVERVIEW *{}-overview*",
|
||||||
|
\ "",
|
||||||
|
\ "REQUIREMENTS *{}-requirements*",
|
||||||
|
\ "",
|
||||||
|
\ "INSTALLATION *{}-installation*",
|
||||||
|
\ "",
|
||||||
|
\ " 1. Plug <https://github.com/junegunn/vim-plug>",
|
||||||
|
\ "",
|
||||||
|
\ " Add the following to your vimrc, or something sourced therein: >",
|
||||||
|
\ "",
|
||||||
|
\ " Plug 'esensar/{}'",
|
||||||
|
\ "<",
|
||||||
|
\ " Then install via `:PlugInstall`",
|
||||||
|
\ "",
|
||||||
|
\ " 2. Pathogen <https://github.com/tpope/vim-pathogen> >",
|
||||||
|
\ "",
|
||||||
|
\ " cd ~/.vim/bundle",
|
||||||
|
\ " git clone https://github.com/esensar/{}.git",
|
||||||
|
\ "<",
|
||||||
|
\ " Then run `:Helptags`",
|
||||||
|
\ "",
|
||||||
|
\ " 3. Manual",
|
||||||
|
\ "",
|
||||||
|
\ " Clone this repository and copy the files in plugin/, autoload/, and doc/",
|
||||||
|
\ " to their respective directories in your vimfiles, or copy the text from",
|
||||||
|
\ " the github repository into new files in those directories. Make sure to",
|
||||||
|
\ " run `:helptags`.",
|
||||||
|
\ "",
|
||||||
|
\ "USAGE *{}-usage*",
|
||||||
|
\ "",
|
||||||
|
\ "COMMANDS *{}-commands*",
|
||||||
|
\ "",
|
||||||
|
\ "FUNCTIONS *{}-functions*",
|
||||||
|
\ "",
|
||||||
|
\ "MAPPINGS *{}-mappings*",
|
||||||
|
\ "",
|
||||||
|
\ "PLUGS *{}-plugs*",
|
||||||
|
\ "",
|
||||||
|
\ "OPTIONS *{}-options*",
|
||||||
|
\ "",
|
||||||
|
\ "ISSUES *{}-issues*",
|
||||||
|
\ "",
|
||||||
|
\ "If you experience issues using {}, please report them at",
|
||||||
|
\ "<https://github.com/esensar/{}/issues>.",
|
||||||
|
\ "",
|
||||||
|
\ "CONTRIBUTING *{}-contributing*",
|
||||||
|
\ "",
|
||||||
|
\ "Feel free to look at already reported issues at ",
|
||||||
|
\ "<https://github.com/esensar/{}/issues>.",
|
||||||
|
\ "If available, check out CONTRIBUTING.md in the repository.",
|
||||||
|
\ "Otherwise, feel free to create a new issue or pull request.",
|
||||||
|
\ "",
|
||||||
|
\ "VERSION *{}-version*",
|
||||||
|
\ "",
|
||||||
|
\ "Version 1.0.0",
|
||||||
|
\ "",
|
||||||
|
\ "LICENSE *{}-license*",
|
||||||
|
\ "",
|
||||||
|
\ "vim:tw=78:ts=2:ft=help:norl:"
|
||||||
|
\ ]
|
||||||
|
\ },
|
||||||
|
\ }
|
||||||
|
\ }
|
||||||
Loading…
Reference in New Issue