Update Documentation on Markdown in Presentation Components #2399

yiwen101 · 2024-02-03T11:19:30Z

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: ☑️

Updated the documentation for feature additions and enhancements
Added tests for bug fixes or features
Linked all related issues
No unrelated changes

Reviewer checklist:

Indicate the SEMVER impact of the PR:

Major (when you make incompatible API changes)
Minor (when you add functionality in a backward compatible manner)
Patch (when you make backward compatible bug fixes)

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):

To be included in the release note for any feature that is made obsolete/breaking

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 · 2024-02-03T11:21:52Z

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files

@@           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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

yucheng11122017

Hi @yiwen101 thanks for the work!
Please do see the comments.
Also please avoid unnecessary changes to the formatting like the new lines, blank spaces and so on! I didn't highlight all of them so please do look through and see what needs to be corrected.

yucheng11122017 · 2024-02-06T14:04:48Z

docs/userGuide/components/presentation.md

@@ -19,16 +19,35 @@
 <div id="overview" class="lead">

 The components in this page are the core **presentational** components you may want to use. Panels and tabs can be used to **organise content sections**, while badges and boxes can **highlight small, specific pieces of information**.
+


Is this new line supports to be below? :)

Thank you for your review and bring my attention to these unnecessary change issue.
I noticed that the majority of these changes are actually done by my IDE formatter automatically on save.
I understand that these changes are redundant and will distract reviewers from the actual changes. Will disable them and manually correct existing changes manually in this PR.

Distracting changes made by formatter fixed.
Thank you for the comment again.

docs/userGuide/components/presentation.md

docs/userGuide/syntax/badges.md

docs/userGuide/syntax/boxes.md

yucheng11122017 · 2024-02-06T14:14:27Z

docs/userGuide/troubleshooting.md

+- using the `markdown` tag
+- using an empty line without any indentation before the markdown content
+
+<panel header="Markdown rendering (Example)" type="seamless">


Can use the codeAndOutput boiler plate for this part to be more consistent! :)
Also maybe can add an example of using empty line?

Noted.
Thank you for the suggestion, requested changes made.

Co-authored-by: Chan Yu Cheng <[email protected]>

yucheng11122017

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

yucheng11122017 · 2024-02-11T01:26:59Z

docs/userGuide/components/presentation.md

+As presentational components are HTML-based, you need to follow the HTML syntax when using markdown in the content of the components.
+More specifically, you should use either:
+- add a line break with no indentation before the markdown content
+- use the `<markdown>` or `<md>`


Suggested change

- use the `<markdown>` or `<md>`

- use the `<markdown>` (block level elements) or `<md>` (inline level elements)

yucheng11122017 · 2024-02-11T01:27:19Z

docs/userGuide/syntax/boxes.md

@@ -228,17 +236,15 @@ type | `String` | `''` | Supports: `info`, `warning`, `success`, `important`, `w
 theme | `String` | `''` | Supports: `primary`, `secondary`, `success`, `danger`, `warning`, `tip`, `light`, `dark` or empty for default.
 light | `Boolean` | `false` | Uses a light color scheme for the box.
 seamless | `Boolean` | `false` | Uses a seamless style for the box. If `light` is specified, this style will not be activated.
-no-border | `Boolean` | `false` | Removes border, except if styled by `border-color` or `border-left-color`. 
+no-border | `Boolean` | `false` | Removes border, except if styled by `border-color` or `border-left-color`.


Formatting issue

yucheng11122017 · 2024-02-11T01:27:23Z

docs/userGuide/syntax/boxes.md

-<box type="warning">
-  warning
-</box>
+<box type="warning"> warning </box>


Formatting issue

yucheng11122017 · 2024-02-11T01:27:27Z

docs/userGuide/syntax/panels.md

-<panel header="primary type panel" type="primary" >
-  ...
-</panel>
+<panel header="primary type panel" type="primary"> ... </panel>


Formatting issue

yucheng11122017 · 2024-02-11T01:27:31Z

docs/userGuide/syntax/panels.md

@@ -248,6 +247,4 @@ type | `String` | `light` | The type or color scheme of the panel (single).<br>S
 <panel header="secondary type panel" type="secondary" minimized>
  ...
 </panel>
-
-


Formatting issue

yucheng11122017 · 2024-02-11T01:28:45Z

docs/userGuide/troubleshooting.md

+
+</variable>
+</include>
+<panel header="Markdown not rendered without singposting(Example)" type="seamless">


Suggested change

<panel header="Markdown not rendered without singposting(Example)" type="seamless">

<panel header="Example of Markdown not rendered without signposting" type="seamless">

yucheng11122017 · 2024-02-11T01:29:42Z

docs/userGuide/troubleshooting.md

+
+You could signpost Markdown either by:
+
+- using the `markdown`(block level elements) or `md`(inline level elements) tags


Suggested change

- using the `markdown`(block level elements) or `md`(inline level elements) tags

- using the `<markdown>` (block level elements) or `<md>` (inline level elements) tags

yucheng11122017 · 2024-02-11T01:32:32Z

docs/userGuide/syntax/badges.md

+</span>
+
+<span class="badge bg-primary">
+<md>**Some Markdown**</md>


Sorry minor point but the bolding isn't obvious in the badge so maybe italics should be more obvious :)

Suggested change

<md>**Some Markdown**</md>

<md>_Some Markdown_</md>

yucheng11122017 · 2024-02-11T01:33:16Z

docs/userGuide/syntax/badges.md

@@ -1,5 +1,19 @@
 ## Badges

+Example:


Suggested change

Example:

**Example:**

yucheng11122017 · 2024-02-11T01:33:24Z

docs/userGuide/syntax/badges.md

+</span>
+</variable>
+</include>
+You can choose from a variety of colors for your badges.  You can also use the `rounded-pill` class to make the badges pill-shaped.


Suggested change

You can choose from a variety of colors for your badges. You can also use the `rounded-pill` class to make the badges pill-shaped.

**You can choose from a variety of colors for your badges. You can also use the `rounded-pill` class to make the badges pill-shaped.**

yiwen101 · 2024-02-11T03:54:09Z

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.

yucheng11122017

LGTM! Don't worry about it. Just make sure you adjust your IDE settings to avoid this issue in the future - also very sad for you to have to fix this over CNY HAHHA

yiwen101 added 4 commits February 3, 2024 16:58

Update trouble shooting

3ae1a6f

Update code examples in affected presentation components

9da62fa

Update message for presentation component

24fa82e

Revert unrelated changes

a99d972

Fix links

9c4b9a5

yiwen101 changed the title ~~Update user doc~~ Update Documentation on Markdown in Presentation Components Feb 3, 2024

yucheng11122017 reviewed Feb 6, 2024

View reviewed changes

yiwen101 and others added 5 commits February 10, 2024 10:21

Update docs/userGuide/components/presentation.md

3c16fb3

Co-authored-by: Chan Yu Cheng <[email protected]>

Merge branch 'master' into update_doc

2009e41

Revert distracting changes made by formatter

fdfdc8b

Resolve merge conflict

b9e4197

Revert distracting changes by formatter2

420ceba

yiwen101 marked this pull request as draft February 10, 2024 03:33

Migrate to codeAndOutput

f2b511b

yiwen101 marked this pull request as ready for review February 10, 2024 05:48

yucheng11122017 reviewed Feb 11, 2024

View reviewed changes

yiwen101 added 4 commits February 11, 2024 11:24

Updade doc

eb6f783

Update presentation.md

0cd7a61

Update ug

c81bb3d

Clean formatting error

a282b01

yiwen101 marked this pull request as draft February 11, 2024 03:36

yiwen101 added 4 commits February 11, 2024 11:41

Proof read

54e1d86

Improve formatting

1d90406

Improve format

2fc7094

Improve format

15b6532

yiwen101 marked this pull request as ready for review February 11, 2024 03:54

yiwen101 added 2 commits February 11, 2024 11:57

Update troubleshooting.md

f7ca43f

Update troubleshooting.md

ac5e734

yucheng11122017 approved these changes Feb 11, 2024

View reviewed changes

yiwen101 merged commit 220cde2 into MarkBind:master Feb 12, 2024
8 checks passed

yucheng11122017 added the r.Patch Version resolver: increment by 0.0.1 label Feb 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Documentation on Markdown in Presentation Components #2399

Update Documentation on Markdown in Presentation Components #2399

yiwen101 commented Feb 3, 2024

codecov bot commented Feb 3, 2024 •

edited

Loading

yucheng11122017 left a comment

yucheng11122017 Feb 6, 2024

yiwen101 Feb 10, 2024

yiwen101 Feb 10, 2024

yucheng11122017 Feb 6, 2024

yiwen101 Feb 10, 2024

yucheng11122017 left a comment

yucheng11122017 Feb 11, 2024

yucheng11122017 Feb 11, 2024

yucheng11122017 Feb 11, 2024

yucheng11122017 Feb 11, 2024

yucheng11122017 Feb 11, 2024

yucheng11122017 Feb 11, 2024

yucheng11122017 Feb 11, 2024

yucheng11122017 Feb 11, 2024

yucheng11122017 Feb 11, 2024

yucheng11122017 Feb 11, 2024

yiwen101 commented Feb 11, 2024

yucheng11122017 left a comment

		@@ -19,16 +19,35 @@
		<div id="overview" class="lead">

		The components in this page are the core presentational components you may want to use. Panels and tabs can be used to organise content sections, while badges and boxes can highlight small, specific pieces of information.

	- use the `<markdown>` or `<md>`
	- use the `<markdown>` (block level elements) or `<md>` (inline level elements)

	<panel header="Markdown not rendered without singposting(Example)" type="seamless">
	<panel header="Example of Markdown not rendered without signposting" type="seamless">


		You could signpost Markdown either by:

		- using the `markdown`(block level elements) or `md`(inline level elements) tags

	- using the `markdown`(block level elements) or `md`(inline level elements) tags
	- using the `<markdown>` (block level elements) or `<md>` (inline level elements) tags

	You can choose from a variety of colors for your badges. You can also use the `rounded-pill` class to make the badges pill-shaped.
	You can choose from a variety of colors for your badges. You can also use the `rounded-pill` class to make the badges pill-shaped.

Update Documentation on Markdown in Presentation Components #2399

Update Documentation on Markdown in Presentation Components #2399

Conversation

yiwen101 commented Feb 3, 2024

codecov bot commented Feb 3, 2024 • edited Loading

Codecov Report

yucheng11122017 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yucheng11122017 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yiwen101 commented Feb 11, 2024

yucheng11122017 left a comment

Choose a reason for hiding this comment

codecov bot commented Feb 3, 2024 •

edited

Loading