Ability to extend required and order of sections rules

RichardLitt / standard-readme-preset

remark preset to configure remark-lint with settings that enforce standard-readme.

ISC License

12 stars 8 forks source link

Ability to extend required and order of sections rules #43

Open jgornick opened 2 years ago

jgornick commented 2 years ago

After reviewing the source code for these 2 rules, I was wondering if there could be a way to extend the options to allow other sections to be required and be in a specific order?

In our specific use case, we want all of our README files to have a "Troubleshooting" section and have it be in a specific order.

Any help would be greatly appreciated! Thank you!

RichardLitt commented 2 years ago

There should be a way! But I don't know what it is at the moment, and I'm so far removed from this project in time that I'm not sure it makes sense for me to dive back into it to find it. Good luck if you end up doing so!