Skip to content

Add options for header numbers and indent #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joelostblom wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add options for header numbers and indent #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8ef054d
Never indent first level headings
joelostblom Feb 23, 2021
dd3ad4e
Allow bullets to be customizable
joelostblom Feb 23, 2021
885f356
Allow indent to be customizable
joelostblom Feb 23, 2021
db47782
Add note in readme about new options
joelostblom Feb 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,16 @@ By default this plugin will not generate an entry for top level headers (`#` or
let g:mdtoc_starting_header_level = 1
```

You can turn off the numbering of headings
```vimscript
let g:mdtoc_number_headers = 0
```

And customize the indentation characters, e.g. to use spaces instead of the default tab
```vimscript
let g:mdtoc_indent = " "
```

## Example

```markdown
Expand Down
20 changes: 18 additions & 2 deletions plugin/markdown-toc.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
if !exists("g:mdtoc_starting_header_level")
let g:mdtoc_starting_header_level = 2
endif
if !exists("g:mdtoc_number_headers")
let g:mdtoc_number_headers = 1
endif
if !exists("g:mdtoc_indent")
let g:mdtoc_indent = "\t"
endif

function! s:HeaderSearchRegex()
if(g:mdtoc_starting_header_level == 1)
Expand Down Expand Up @@ -34,7 +40,7 @@ function! s:FindHeaders()
endfunction

function! s:HeadingLevel(header)
let l:delim = split(a:header, " ")[0]
let l:delim = split(a:header, " ")[0]
if(l:delim[0] == "=")
return 1
elseif(l:delim[0] == "-")
Expand Down Expand Up @@ -62,8 +68,18 @@ function! s:GenerateMarkdownTOC()
let l:num = l:levelsStack[-1]
let l:levelsStack[-1] = l:num + 1
let l:previousLevel = l:headingLevel
if(g:mdtoc_number_headers == 1)
let l:bullet = l:num . ". "
else
let l:bullet = "- "
endif

if(l:headingLevel == 1)
let l:formattedLine = repeat("", l:headingLevel - g:mdtoc_starting_header_level) . l:bullet . "[" . sectionName . "](#" . sectionId . ")"
else
let l:formattedLine = repeat(g:mdtoc_indent, l:headingLevel - g:mdtoc_starting_header_level) . l:bullet . "[" . sectionName . "](#" . sectionId . ")"
endif

let l:formattedLine = repeat("\t", l:headingLevel - g:mdtoc_starting_header_level) . l:num . ". [" . sectionName . "](#" . sectionId . ")"
put =l:formattedLine
endfor
endfunction
Expand Down