MarkBind / markbind

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

Update Documentation on Markdown in Presentation Components #2399

Closed yiwen101 closed 7 months ago

yiwen101 commented 8 months ago

What is the purpose of this pull request?

Resolves #2371

**Overview of changes: Add the rule of using markdown in presentation component in "trouble shooting" and "presentation components" section of the user doc. Update the code example of the four presentation component

Anything you'd like to highlight/discuss: NA

Testing instructions: NA

Proposed commit message: (wrap lines at 72 characters) Update user doc on markdown syntax for presentation component


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).
codecov[bot] commented 8 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (a265c73) 48.87% compared to head (ac5e734) 48.87%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2399 +/- ## ======================================= Coverage 48.87% 48.87% ======================================= Files 124 124 Lines 5238 5238 Branches 1109 1109 ======================================= Hits 2560 2560 Misses 2371 2371 Partials 307 307 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

yiwen101 commented 7 months ago

Hi @yiwen101 thank you for the changes! Some more formatting errors and some minor nits and we should be good to go :)

Thank you so much for the meticulous review, I feel so bad forcing you pointing out so many formatting issues, especially during the CNY holiday. I have made the requested adjustment (and some other minor changes). Thank you for your reviews and help again.