Improve compatibility with DocToc action

[mdeweerd]

Describe the problem/need and solution

Context
Use https://github.com/marketplace/actions/toc-generator and mdformat "together".

Problem / Idea

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- param::isNotitle::true:: -->
<!-- param::maxHeaderLevel::4:: -->

<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
<!-- END doctoc generated TOC please keep comment here to allow auto update -->

changes to

 <!-- START doctoc generated TOC please keep comment here to allow auto update -->

 <!-- param::isNotitle::true:: -->

 <!-- param::maxHeaderLevel::4:: -->

And the options are no longer used by doctoc in this action and disappear.

Solution
This could be fixed by skipping that section/adding a method to skip sections.

Benefit
This allows automatic TOC generation while keeping the DocToc options.

Guide for implementation

No response

Tasks and updates

No response

[welcome]

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

[hukkin]

Thanks for the issue!

I'm hesitant to add special casing like this. I'd suggest one of the following first

• Use mdformat-toc to generate ToC with mdformat instead (my experience is that doctoc can be a bit buggy)
• Open an issue in https://github.com/thlorenz/doctoc and ask if they'd be able to ignore the added newline.

[mdeweerd]

Ok, I'll am checking out mdformat-toc.

However - seeing that mdformat-toc also uses html comments -- a feature to exlude part of the md file formatting could "fix" this and other particularities.

<!-- mdformat-skip -->
Not reformatted.
<!-- mdformat-skip-end -->

[mdeweerd]

• Thanks for your reply & hint.

[hukkin]

a feature to exlude part of the md file formatting could "fix" this

An issue for this exists: #53

Thanks for your reply & hint.

You're welcome! Please close this issue if mdformat-toc solves your issue