feat: Add option to use HTML comments instead of details/summary

[heiskr]

Why:

Towards https://github.com/github/skills/issues/40

What's being changed:

Currently step authoring looks like this:

<details id=0 open>
  <summary>Start</summary>
</details>

<details id=1>
  <summary>Step 1</summary>
</details>

<details id=2>
  <summary>Step 2</summary>
</details>

<details id=X>
  <summary>Finish</summary>
</details>

This would create the option to also author steps like:

<!--step0-->
Start
<!--endstep0-->

<!--step1
Step 1
endstep1-->

<!--step2
Step 2
endstep2-->

<!--stepX
Finish
endstepX-->

The purpose of this change would be to hide the step content when starting a course. I tried to think of the easiest way to do this without confusing course authors or creating a big change to how the actions workflows work. For learners this means they would only see the current step they are on. For authors, this means you'd need to play with the HTML comments a bit to see what you are currently working on.

[emilyistoofunky]

Thanks @heiskr! I like this option. I think we should choose one or the other as our default.

Could you explain this a bit more?

For authors, this means you'd need to play with the HTML comments a bit to see what you are currently working on.

[heiskr]

So if the markdown file looks like this:

<!--step0-->
Start
<!--endstep0-->

<!--step1
Step 1
endstep1-->

<!--step2
Step 2
endstep2-->

<!--stepX
Finish
endstepX-->

Then only the "start" would be viewable, so you'd need to close up the HTML comment to see the section you are working on...

<!--step1-->
Step 1
<!--endstep1-->

...and then change it back before committing...

<!--step1
Step 1
endstep1-->

[heiskr]

Merging, leaving the "default" decision up to @dihydroJenoxide

[github-actions]

🎉 This PR is included in version 1.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀