MarkBind / markbind

MarkBind is a tool for generating content-heavy websites from source files in Markdown format
https://markbind.org/
MIT License
134 stars 123 forks source link

Remove Overridden Question Attributes in Documentation #2513

Closed luminousleek closed 2 months ago

luminousleek commented 2 months ago

What is the purpose of this pull request?

Fixes #2512 Related to #2511

Overview of changes:

Remove header and hint attributes in question with header and hint slots.

Anything you'd like to highlight/discuss:

The page on the User Guide in question is this. Expand the panel entitled Header and Hint example with slots.

This still achieves the purpose of the documentation, which is to show how slots can replace the header and hint attributes.

Testing instructions:

Switch to the branch for PR #2511, navigate to the docs directory and run markbind serve -d. Logger warnings should appear. Then, make the changes in this PR, and run markbind serve-d again. There should not be logger warnings anymore.

Proposed commit message: (wrap lines at 72 characters)

Remove Overridden Question Attributes in Docs

The docs currently has a question where there are slots overriding
the header attributes. However, when #2511 is merged, logger
warnings about this overriding will be triggered, leading to the
check-docs GitHub action failing.

Let's remove the header attributes so that they will not trigger
the logger warning. Let's also update the sample code to reflect
this change.

Checklist: :ballot_box_with_check:


Reviewer checklist:

Indicate the SEMVER impact of the PR:

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

Give a brief explanation note about:

  • what was the old feature that was made obsolete
  • any replacement feature (if any), and
  • how the author should modify his website to migrate from the old feature to the replacement feature (if possible).
github-actions[bot] commented 2 months ago

@kaixin-hc Each PR must have a SEMVER impact label, please remember to label the PR properly.