Allow customization of header level of TOC #629
Conversation
Instead of forcing the TOC to always be at header level 1, allow the user to specify via the option g:vimwiki_toc_header_level what level they want. This defaults to 1, so if the user does nothing then the old behavior will remain the same.
|
For posterity, can you provide the files you tested this with, and the procedures you used to test? |
|
let g:vimwiki_toc_header_level = 3In a new file called = Foo =
* Test
== Bar ==
* TestRun === Contents ===
- [[#Foo|Foo]]
- [[#Foo#Bar|Bar]]Run If = Contents =
- [[#Foo|Foo]]
- [[#Foo#Bar|Bar]]as before, and the resulting HTML will have an |
|
I like this change. The only issue I see is that the TOC is still inserted at the top of the file. This most likely doesn't make sense if using a header level other than 1 (you probably don't want to end up with H3 for the TOC followed by an H1 header for something else). It does work to manually move the TOC to a desired location and then updates work on the that location. Any ideas on a better way to handle this? |
|
I think having the TOC inserted at the top by default is fine, since there is nothing that says an h3 or h2 cannot precede an h1. My motivation for doing this was actually because I wanted the TOC at the top, but I didn't want the "Contents" header to be the same size/boldface as my "actual" headers. In the case that a user wants the TOC somewhere else in their document, they can manually initialize it wherever they want, as you said. |
|
Makes sense. I think it would be useful to have a command that inserts the TOC at the current cursor position (or something similar) but that can be left for another day. Thanks for the PR! |
Instead of forcing the TOC to always be at header level 1, allow the
user to specify via the option g:vimwiki_toc_header_level what level
they want.
This defaults to 1, so if the user does nothing then the old behavior
will remain the same.
Closes #626.