Skip to content

Commit

Permalink
Fix inconsistencies between MD and Docs (#39597)
Browse files Browse the repository at this point in the history
  • Loading branch information
felicitymay authored Jul 25, 2023
1 parent 0c774c6 commit eb678c5
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions content/contributing/writing-for-github-docs/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -966,7 +966,7 @@ For example in the following table, in order to make sense of the "Yes" and "No"
</tr>
</table>

To add row headers for a Markdown table, wrap the table in the Liquid tags `{% rowheaders %} {% endrowheaders %}`. For more information about using row headers, see "[Table row headers](https://github.com/github/docs/blob/main/contributing/content-markup-reference.md#table-row-headers)" in the content markup reference.
To add row headers for a Markdown table, wrap the table in the Liquid tags `{% raw %}{% rowheaders %} {% endrowheaders %}{% endraw %}`. For more information about using row headers, see "[Table row headers](https://github.com/github/docs/blob/main/contributing/content-markup-reference.md#table-row-headers)" in the content markup reference.

### Include a value for every cell
Every cell in a table must contain a value. If the table has row headers, the first cell (cell A1) can be empty.
Expand Down Expand Up @@ -1052,13 +1052,15 @@ The following example shows part of a table from "[AUTOTITLE](/free-pro-team@lat
</tbody>
</table>

````
The table is generated with the following alignment syntax.

```text
| Option | Required | Security Updates | Version Updates | Description |
|---------------------|:--------:|:----------------:|:---------------:|--------------------------------|
| `package-ecosystem` |{% octicon "check" aria-label="Supported" %}|{% octicon "x" aria-label="Not supported" %}|{% octicon "check" aria-label="Supported" %}| Package manager to use |
| `directory` |{% octicon "check" aria-label="Supported" %}|{% octicon "x" aria-label="Not supported" %}|{% octicon "check" aria-label="Supported" %}| Location of package manifests |
| `schedule.interval` |{% octicon "check" aria-label="Supported" %}|{% octicon "x" aria-label="Not supported" %}|{% octicon "check" aria-label="Supported" %}| How often to check for updates |
````
| `package-ecosystem` |{% raw %}{% octicon "check" aria-label="Supported" %}|{% octicon "x" aria-label="Not supported" %}|{% octicon "check" aria-label="Supported" %}{% endraw %}| Package manager to use |
| `directory` |{% raw %}{% octicon "check" aria-label="Supported" %}|{% octicon "x" aria-label="Not supported" %}|{% octicon "check" aria-label="Supported" %}{% endraw %}| Location of package manifests |
| `schedule.interval` |{% raw %}{% octicon "check" aria-label="Supported" %}|{% octicon "x" aria-label="Not supported" %}|{% octicon "check" aria-label="Supported" %}{% endraw %}| How often to check for updates |
```

## Titles

Expand Down Expand Up @@ -1369,4 +1371,4 @@ See the “[Product names](#product-names)” section of this guide.

Avoid stacked modifiers (strings of nouns), which can lead to incorrect translations because translations may not be able to tell which word is modifying the other. You can rephrase the string of nouns using a preposition. If using a stacked modifier is essential, make sure the background information and context are clear so that readers and the translator can understand what is being modified.
- **Use:** Default source settings for public repositories
- **Avoid:** Public repository default source settings
- **Avoid:** Public repository default source settings

0 comments on commit eb678c5

Please sign in to comment.