Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
N
nexpie-grafana-theme
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Registry
Registry
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Kornkitt Poolsup
nexpie-grafana-theme
Commits
0138bbee
Unverified
Commit
0138bbee
authored
Sep 25, 2020
by
Diana Payton
Committed by
GitHub
Sep 25, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update documentation-markdown-guide.md (#27817)
parent
9335c92e
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
10 additions
and
13 deletions
+10
-13
contribute/style-guides/documentation-markdown-guide.md
+10
-13
No files found.
contribute/style-guides/documentation-markdown-guide.md
View file @
0138bbee
...
@@ -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 M
arkdown emoji should _only_ appear in specific cases.
**Example:**
GitHub
-flavored m
arkdown 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
B
lock quotes inside text using right-facing arrows:
Include
b
lock 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 "()".
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment