1
0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-22 03:40:46 +03:00

Troubleshooting: Add comment about getting the VIM TOC plugin working

Athanasius 2020-12-12 19:58:03 +00:00
parent 8e40a05c06
commit 3315033d89

@ -1,6 +1,35 @@
Contents
===
<!--
This Table of Contents (TOC) is generated using the `vim-markdown-toc`
plugin for VIM from
<https://rderik.com/blog/generate-table-of-contents-with-anchors-for-markdown-file-vim-plugin/>
You first need to install vim-plug as per
<https://github.com/junegunn/vim-plug> . This can be as simple as:
mkdir -p ~/.vim/autoload
curl -fLo ~/.vim/autoload/plug.vim https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
Minimum ~/.vimrc to get this working:
----------------
call plug#begin('~/.vim/plugged')
" Create Table of Content from Markdown files
Plug 'rderik/vim-markdown-toc', { 'branch': 'add-anchors-to-headings/drc2r' }
" Initialize plugin system
call plug#end()
" Vim markdown Table of Contents
let g:vmt_insert_anchors = 1
let g:vmt_auto_update_on_save = 1
----------------
The above will mean the TOC is updated on each file save.
To manually remove just use :RemoveToc
Then to add it back :GenTocRedCarpet
-->
<!-- vim-markdown-toc Redcarpet -->
* [I ran the program with "run as Administrator" and ...](#i-ran-the-program-with-quot-run-as-administrator-quot-and)