1
0
mirror of synced 2025-12-25 02:17:36 -05:00

Add entry for indentation to style guide (#16728)

* Add entry for indentation

* Update contributing/content-style-guide.md

Co-authored-by: Laura Coursen <lecoursen@github.com>

Co-authored-by: Laura Coursen <lecoursen@github.com>
This commit is contained in:
Emily Gould
2020-12-02 16:01:51 -06:00
committed by GitHub
parent 4a66fdf5e0
commit 8917055830

View File

@@ -12,6 +12,7 @@ These guidelines are specific to GitHubs documentation. For general style que
- [Code blocks](#code-blocks)
- [Commands](#commands)
- [Examples](#examples)
- [Indentation](#indentation)
- [Headers](#headers)
- [Images](#images)
- [Alt text](#alt-text)
@@ -129,6 +130,21 @@ schedule:
- cron: "40 19 * * *"
```
### Indentation
In YAML examples, such as actions and workflow files, use two spaces to indent lines within nested lists and block sequences.
- **Use:**
```yaml
steps:
- uses: actions/checkout@v2
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python }}
```
## Headers
Use H3 for headers, and H4 for subheaders. When referring to headers, surround the header name with quotation marks.