Skip to content

Hiding sections

Use the comments <!-- START mdsplit-ignore --> and <!-- END mdsplit-ignore --> to ignore sections from your README.md. For instance:

1
2
3
4
5
6
<!-- START mdsplit-ignore -->
# Section to ignore

`mdsplit` will remove this whole section from your documentation.

<!-- END mdsplit-ignore -->

or

1
2
3
4
5
# Section to ignore

<!-- START mdsplit-ignore -->
`mdsplit` will remove this paragraph from your documentation.
<!-- END mdsplit-ignore -->

If you ignore the complete section, mdsplit will create no file for that section.

If you're reading this from README.md you will see this section has a subsection that will be completely ignored in the documentation.