File tree 3 files changed +7
-7
lines changed
3 files changed +7
-7
lines changed Original file line number Diff line number Diff line change @@ -27,10 +27,10 @@ There are two ways to contribute a pull request to the docs repository:
27
27
28
28
Here’s a list of some of the important files:
29
29
30
- - ` /_data/toc.yaml ` defines the left-hand navigation for the docs
31
- - ` /js/docs.js ` defines most of the docs-specific JS such as the table of contents (ToC) generation and menu syncing
32
- - ` /css/style.scss ` defines the docs-specific style rules
33
- - ` /_layouts/docs.html ` is the HTML template file, which defines the header and footer, and includes all the JS/CSS that serves the docs content
30
+ - ` /_data/toc.yaml ` defines the left-hand navigation for the docs.
31
+ - ` /js/docs.js ` defines most of the docs-specific JS such as the table of contents (ToC) generation and menu syncing.
32
+ - ` /css/style.scss ` defines the docs-specific style rules.
33
+ - ` /_layouts/docs.html ` is the HTML template file, which defines the header and footer, and includes all the JS/CSS that serves the docs content.
34
34
35
35
### Files not edited here
36
36
@@ -71,7 +71,7 @@ git clone {{ site.repo }}.git
71
71
cd docs
72
72
```
73
73
74
- Then, build and run the documentation using [ Docker Compose] ( ../compose/index.md )
74
+ Then, build and run the documentation using [ Docker Compose] ( ../compose/index.md ) :
75
75
76
76
``` bash
77
77
docker compose up -d --build
Original file line number Diff line number Diff line change @@ -76,7 +76,7 @@ as possible for you to work in this repository. The following sections guide you
76
76
77
77
We also provide:
78
78
79
- - A section of useful components you can add to your documentation. For components and controls, we use [ Bootstrap] ( https://getbootstrap.com )
79
+ - A section of useful components you can add to your documentation. For components and controls, we use [ Bootstrap] ( https://getbootstrap.com ) .
80
80
- Information on Docker's [ tone and voice] ( style/voice-tone.md ) .
81
81
- A [ writing checklist] ( checklist.md ) to help you when you're contributing to Docker's documentation.
82
82
- A command-line tool called vale to check the style and [ help you find errors in your writing] ( contribute-guide.md#test-the-docs-locally ) .
Original file line number Diff line number Diff line change @@ -25,7 +25,7 @@ Page titles should be action orientated. For example:
25
25
26
26
### Best practice:
27
27
28
- - Make sure the title of your page and the TOC entry matches
28
+ - Make sure the title of your page and the TOC entry matches.
29
29
- If you want to use a ‘:’ in a page title in the table of contents (_ toc.yaml), you must wrap the entire title in “” to avoid breaking the build.
30
30
31
31
## Images
You can’t perform that action at this time.
0 commit comments