mirror of
https://github.com/kubernetes-sigs/node-feature-discovery.git
synced 2025-03-05 16:27:05 +00:00
8bb46345e7
Make table of contents in the pages cleaner and more readable by
dropping the main heading (H1 level) from TOCs. This was the original
intention with the usage of "no_toc" kramdown magic, which was broken,
however. The kramdown class magic needs to be specified on the line
immediately following the headinds, otherwise it has no effect. We need
to disable MD022 rule of mdlint as it does not understand this magic.
(cherry picked from commit 819f333118)
9 lines
382 B
Ruby
9 lines
382 B
Ruby
all
|
|
# Exclude MD022 - Headers should be surrounded by blank lines. The kramdown
|
|
# "class magic" (like {: .no_toc}) needs to be directly below the heading line.
|
|
exclude_rule 'MD022'
|
|
# Exclude MD041 - First line in file should be a top level header
|
|
exclude_rule 'MD041'
|
|
rule 'MD013', :tables => false
|
|
rule 'MD013', :code_blocks => false
|
|
rule 'MD024', :allow_different_nesting => true
|