mirror of https://github.com/docker/docs.git
a few more edits
This commit is contained in:
parent
611a8487fe
commit
a5534b339d
|
@ -7,8 +7,6 @@ toc_max: 3
|
|||
|
||||
It is best practice if [a link opens in a new window](https://docker.com/){: target="_blank" rel="noopener" class="_" }
|
||||
|
||||
You can also have [a markdown link to a custom target ID](#HTML)
|
||||
|
||||
#### Links to auto-generated content
|
||||
|
||||
An example of a link to an auto-generated reference page that we pull in during docs builds:
|
||||
|
|
|
@ -10,7 +10,7 @@ When you create a new .md file for new content, make sure:
|
|||
- File names are as short as possible
|
||||
- Try to keep the file name to one word or two words
|
||||
- Use a dash to separate words. For example:
|
||||
- `add-seats.md` and `remove-seats.md` which you can find under /subscription.
|
||||
- `add-seats.md` and `remove-seats.md`.
|
||||
- `multiplatform-images` preferred to `multi-platform-images`.
|
||||
|
||||
## Frontmatter
|
||||
|
@ -58,36 +58,6 @@ toc_max: 4
|
|||
|
||||
The body of the page (with the exception of keywords) starts after the frontmatter
|
||||
|
||||
### Paragraphs and new lines
|
||||
|
||||
**To change the line without creating a paragraph:**
|
||||
|
||||
Convention:
|
||||
|
||||
✅ 2 trailing spaces (at the end of line). As in sample below where “[]” represents a whitespace character.
|
||||
|
||||
```markdown
|
||||
This is a sample sentence[][].
|
||||
Next sentence coming here.
|
||||
```
|
||||
|
||||
❌Don’t use the HTML tag <br/>
|
||||
|
||||
Context:
|
||||
|
||||
We want to avoid mixing HTML with our markdown markup as much possible. There are some HTML tags that we use that provide some presentation enrichment like tabs, etc. but we prefer the markdown markup whenever it solves the ask in question.
|
||||
|
||||
**Note** that simple trailing and isolated white spaces will probably be removed after linters are applied.
|
||||
|
||||
**Paragraphs**
|
||||
|
||||
CR:LF or pressing ENTER to create new lines
|
||||
|
||||
**Indentation ?**
|
||||
|
||||
- Empty lines and end of file
|
||||
- Cross-references and upstream repos
|
||||
|
||||
### Text length
|
||||
|
||||
Splitting long lines (preferably up to 80 characters) can make it easier to provide feedback on small chunks of text.
|
||||
|
|
Loading…
Reference in New Issue