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
0
Merge Requests
0
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
Boxiang Sun
gitlab-ce
Commits
0bfd119e
Commit
0bfd119e
authored
Jan 24, 2019
by
Marcia Ramos
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Document docs style exceptions
parent
12c189fe
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
33 additions
and
0 deletions
+33
-0
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+33
-0
No files found.
doc/development/documentation/styleguide.md
View file @
0bfd119e
...
...
@@ -95,6 +95,20 @@ yield a useful result, and ensuring content is helpful and easy to consume.
- List item 2
```
### Tables overlapping the ToC
By default, all tables have a width of 100% on docs.gitlab.com.
In a few cases, the table will overlap the table of contents (ToC).
For these cases, add an entry to the document's frontmatter to
render them displaying block. This will make sure the table
is displayed behind the ToC, scrolling horizontally:
```md
---
table_display_block: true
---
```
## Emphasis
- Use double asterisks (`**`) to mark a word or text in bold (`**bold**`).
...
...
@@ -222,6 +236,15 @@ For other punctuation rules, please refer to the
E.g., instead of writing something like `Read more about GitLab Issue Boards [here](LINK)`,
write `Read more about [GitLab Issue Boards](LINK)`.
### Unlinking emails
By default, all email addressed will render in an email tag on docs.gitlab.com.
To escape the code block and unlink email addresses, use two backticks:
```
md
`` example@email.com ``
```
## Navigation
To indicate the steps of navigation through the UI:
...
...
@@ -262,6 +285,16 @@ Inside the document:
- If a heading is placed right after an image, always add three dashes (`---`)
between the image and the heading.
### Remove image shadow
All images displayed on docs.gitlab.com have a box shadow by default.
To remove the box shadow, use the image class `.image-noshadow` applied
directly to an HTML `img` tag:
```
html
<img
src=
"path/to/image.jpg"
alt=
"Alt text (required)"
class=
"image-noshadow"
>
```
## Code blocks
- Always wrap code added to a sentence in inline code blocks (``` ` ```).
...
...
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