knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added definition list formatting rule (#4144) 

* Added definition list formatting rule

* Add example
This commit is contained in:
RichardJJG 2021-08-20 14:30:06 +01:00 committed by GitHub
parent e645da059c
commit 65b1671247
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/help/contributor/style-guide/style-and-formatting.md
View File

@ -60,6 +60,14 @@ between the number and the unit.
|Click **Fork** | Click "Fork"
|Select **Other** | Select "Other"
### Use tables for definition lists
When listing terms and their definitions, use table formatting instead of definition list formatting.
|:white_check_mark: Correct |:no_entry: Incorrect
|--------------------|-----
|`|Value |Description |`<br>`|------|---------------------|`<br>`|Value1|Description of Value1|`<br>`|Value2|Description of Value2|`|`Value1`<br>`: Description of Value1`<br><br>`Value2`<br>`: Description of Value2`|
## General style
### Use upper camel case for Knative API objects