Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
a66532bc
Commit
a66532bc
authored
Sep 11, 2020
by
Mike Jang
Committed by
Craig Norris
Sep 11, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add info that we allow alternative words in alert boxes
parent
cd6cf73b
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
13 additions
and
3 deletions
+13
-3
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+13
-3
No files found.
doc/development/documentation/styleguide.md
View file @
a66532bc
...
...
@@ -1410,8 +1410,8 @@ example:
## Alert boxes
When
ever
you need to call special attention to particular sentences, use the
following markup
for highlighting
.
When you need to call special attention to particular sentences, use the
following markup
to create highlighted alert boxes
.
Note that the alert boxes only work for one paragraph only. Multiple paragraphs,
lists, headers and so on, will not render correctly. For multiple lines, use
...
...
@@ -1421,6 +1421,16 @@ Alert boxes render only on the GitLab documentation site (<https://docs.gitlab.c
Within GitLab itself, they will appear as plain Markdown text (like the examples
above the rendered versions, below).
These alert boxes are used in the GitLab documentation. These aren't strict
guidelines, but for consistency you should try to use these values:
| Color | Markup | Default keyword | Alternative keywords |
|--------|------------|-----------------|----------------------------------------------------------------------|
| Blue |
`NOTE:`
|
`**Note:**`
| |
| Yellow |
`CAUTION:`
|
`**Caution:**`
|
`**Warning:**`
,
`**Important:**`
|
| Red |
`DANGER:`
|
`**Danger:**`
|
`**Warning:**`
,
`**Important:**`
,
`**Deprecated:**`
,
`**Required:**`
|
| Green |
`TIP:`
|
`**Tip:**`
| |
### Note
Notes catch the eye of most readers, and therefore should be used very sparingly.
...
...
@@ -1637,7 +1647,7 @@ heading level.
warning such as:
```
markdown
CAUTION:
**Warning
:**
DANGER:
**Deprecated
:**
This feature was
[
deprecated
](
link-to-issue
)
in GitLab 12.3
and replaced by
[
Feature name
](
link-to-feature-documentation
)
.
```
...
...
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