Commit 0138bbee by Diana Payton Committed by GitHub

Update documentation-markdown-guide.md (#27817)

parent 9335c92e
...@@ -24,15 +24,14 @@ Start your document with a single ``#`` for the title of the page. Add the sub-h ...@@ -24,15 +24,14 @@ Start your document with a single ``#`` for the title of the page. Add the sub-h
**Example:** It is ``**important**`` to use GitHub Flavored Markdown emoji consistently. **Example:** It is ``**important**`` to use GitHub Flavored Markdown emoji consistently.
* Make text ``*emphasized*`` using single `` _underscores_`` or a single asterisk. * Make text ``_emphasized_`` using single `` _underscores_``. Do not use the single asterisk, it can be easily confused with bold.
**Example:** GitHub Flavored Markdown emoji should _only_ appear in specific cases. **Example:** GitHub-flavored markdown emoji should _only_ appear in specific cases.
## Links and references ## Links and references
Create links to other website by wrapping the display text in square brackets, and Create links to other website by wrapping the display text in square brackets, and the web URL in curved brackets.
the web URL in curved brackets.
\[text to display](www.website.com) \[text to display](www.website.com)
...@@ -40,7 +39,7 @@ the web URL in curved brackets. ...@@ -40,7 +39,7 @@ the web URL in curved brackets.
## Block quotes ## Block quotes
Include Block quotes inside text using right-facing arrows: Include block quotes inside text using right-facing arrows:
**Example** **Example**
...@@ -117,13 +116,13 @@ The list above will always display as: ...@@ -117,13 +116,13 @@ The list above will always display as:
### Unordered lists ### Unordered lists
Build a list of points - an unordered or unnumbered list - by Build a list of points - an unordered or unnumbered list - by
using "\*" characters. using "\-" (hyphen) characters.
**Example** **Example**
* First - First
* Another item - Another item
* The last list item - The last list item
## Images ## Images
...@@ -135,10 +134,8 @@ This follows the format of "!", alt text wrapped in "[]" and the link URL wrappe ...@@ -135,10 +134,8 @@ This follows the format of "!", alt text wrapped in "[]" and the link URL wrappe
## Comments ## Comments
You can include comments that will not appear in published markdown using the You can include comments that will not appear in published markdown using the following syntax:
following syntax:
\[comment]: <> (Comment text to display) \[comment]: <> (Comment text to display)
The word "comment" wrapped in "[]" followed by a ":", a space, "<>", and then The word "comment" wrapped in "[]" followed by a ":", a space, "<>", and then the comment itself wrapped in "()".
the comment itself wrapped in "()".
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment