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
58c4d561
Commit
58c4d561
authored
May 04, 2020
by
Craig Norris
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add table info to Docs Style Guide
parent
99450432
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
35 additions
and
0 deletions
+35
-0
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+35
-0
No files found.
doc/development/documentation/styleguide.md
View file @
58c4d561
...
...
@@ -565,6 +565,41 @@ to mix types, that is also possible, as long as you don't mix items at the same
-
Unordered list item three.
```
## Tables
Tables should be used to describe complex information in a straightforward
manner. Note that in many cases, an unordered list is sufficient to describe a
list of items with a single, simple description per item. But, if you have data
that is best described by a matrix, tables are the best choice for use.
### Creation guidelines
Due to accessibility and scanability requirements, tables should not have any
blank cells or areas. If a cell does not have a useable value, consider using
*none*
as a value.
To help tables be easier to maintain, consider adding additional spaces to the
column widths to make them consistent. For example,
```
markdown
| Header 1 | Header 2 |
| Item 1 | Description |
| Item 2 | Expanded description |
```
If you're using Visual Studio Code, consider installing and using the
[
Markdown Table Prettifier
](
https://marketplace.visualstudio.com/items?itemName=darkriszty.markdown-table-prettify
)
extension.
### Feature tables
When creating tables of lists of features (such as whether or not features are
available to certain roles on the
[
Permissions
](
../../user/permissions.md#project-members-permissions
)
page), use the following phrases (based on the SVG icons):
*
No:
**{dotted-circle}**
No
*
Yes:
**{checked-circle}**
Yes
## Quotes
Valid for Markdown content only, not for frontmatter entries:
...
...
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