1
0
mirror of synced 2025-12-23 03:44:00 -05:00

Fix all <!-- markdownlint-disable-line fenced-code-language -->

This commit is contained in:
Kevin Heis
2023-09-25 10:26:33 -07:00
parent 3c41c5d3db
commit d436652f58
41 changed files with 151 additions and 151 deletions

View File

@@ -55,7 +55,7 @@ For information on when to use callout tags, see "[AUTOTITLE](/contributing/writ
### Example usage of a callout
``` <!-- markdownlint-disable-line fenced-code-language -->
```markdown
{% raw %}{% note %}
**Note:** Owners and administrators can add outside collaborators to a repository.
@@ -163,7 +163,7 @@ We occasionally need to write documentation for different operating systems. Eac
### Example usage of operating system tags
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% mac %}
These instructions are pertinent to Mac users.
@@ -171,7 +171,7 @@ These instructions are pertinent to Mac users.
{% endmac %}{% endraw %}
```
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% linux %}
These instructions are pertinent to Linux users.
@@ -179,7 +179,7 @@ These instructions are pertinent to Mac users.
{% endlinux %}{% endraw %}
```
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% windows %}
These instructions are pertinent to Windows users.
@@ -199,7 +199,7 @@ You can define a default tool for an article in the YAML frontmatter. For more i
### Example usage of tool tags
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% api %}
These instructions are pertinent to API users.
@@ -207,7 +207,7 @@ These instructions are pertinent to API users.
{% endapi %}{% endraw %}
```
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% bash %}
These instructions are pertinent to Bash shell commands.
@@ -215,7 +215,7 @@ These instructions are pertinent to Bash shell commands.
{% endbash %}{% endraw %}
```
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% cli %}
These instructions are pertinent to GitHub CLI users.
@@ -223,7 +223,7 @@ These instructions are pertinent to GitHub CLI users.
{% endcli %}{% endraw %}
```
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% codespaces %}
These instructions are pertinent to Codespaces users. They are mostly used outside the Codespaces docset, when we want to refer to how to do something inside Codespaces. Otherwise `webui` or `vscode` may be used.
@@ -231,7 +231,7 @@ These instructions are pertinent to Codespaces users. They are mostly used outsi
{% endcodespaces %}{% endraw %}
```
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% curl %}
These instructions are pertinent to curl commands.
@@ -239,7 +239,7 @@ These instructions are pertinent to curl commands.
{% endcurl %}{% endraw %}
```
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% desktop %}
These instructions are pertinent to GitHub Desktop.
@@ -247,7 +247,7 @@ These instructions are pertinent to curl commands.
{% enddesktop %}{% endraw %}
```
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% importer_cli %}
These instructions are pertinent to GitHub Enterprise Importer CLI users.
@@ -255,7 +255,7 @@ These instructions are pertinent to GitHub Enterprise Importer CLI users.
{% endimporter_cli %}{% endraw %}
```
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% javascript %}
These instructions are pertinent to javascript users.
@@ -263,7 +263,7 @@ These instructions are pertinent to javascript users.
{% endjavascript %}{% endraw %}
```
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% jetbrains %}
These instructions are pertinent to users of JetBrains IDEs.
@@ -271,7 +271,7 @@ These instructions are pertinent to users of JetBrains IDEs.
{% endjetbrains %}{% endraw %}
```
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% powershell %}
These instructions are pertinent to `pwsh` and `powershell` commands.
@@ -279,7 +279,7 @@ These instructions are pertinent to `pwsh` and `powershell` commands.
{% endpowershell %}{% endraw %}
```
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% vscode %}
These instructions are pertinent to VS Code users.
@@ -287,7 +287,7 @@ These instructions are pertinent to VS Code users.
{% endvscode %}{% endraw %}
```
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% webui %}
These instructions are pertinent to GitHub UI users.
@@ -307,7 +307,7 @@ If you create a table where the first column contains headers for the table rows
### Example table with row headers
``` <!-- markdownlint-disable-line fenced-code-language -->
```markdown
{% raw %}{% rowheaders %}
| | Mona | Tom | Hobbes |
@@ -320,7 +320,7 @@ If you create a table where the first column contains headers for the table rows
### Example table without row headers
``` <!-- markdownlint-disable-line fenced-code-language -->
```markdown
| Name | Vocation |
| ------ | ---------------- |
| Mona | GitHub mascot |
@@ -354,15 +354,15 @@ The links to Markdown pages undergo some transformations on the server side to m
For example, if you include the following link in a content file:
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
/github/writing-on-github/creating-a-saved-reply
```
When viewed on {% data variables.product.prodname_dotcom_the_website %} docs, the link gets rendered with the language code:
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
/en/github/writing-on-github/creating-a-saved-reply
```
and when viewed on {% data variables.product.prodname_ghe_server %} docs, the version is included as well:
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
/en/enterprise-server@2.20/github/writing-on-github/creating-a-saved-reply
```
For more information about links, see "[AUTOTITLE](/contributing/writing-for-github-docs/style-guide#links)."

View File

@@ -144,13 +144,13 @@ The Liquid operators `==`, `>=`, and `<=` are not supported in the {% data varia
When all operands must be true for the condition to be true, use the operator `and`:
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% ifversion ghes > 2.21 and ghes < 3.1 %}{% endraw %}
```
When at least one operand must be true for the condition to be true, use the operator `or`:
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{% ifversion fpt or ghes > 2.21 %}{% endraw %}
```
@@ -162,13 +162,13 @@ When using Liquid conditionals in lists or tables, you can use [whitespace contr
You can add a hyphen (`-`) on either the left, right, or both sides to indicate that there should be no newline or other whitespace on that side.
``` <!-- markdownlint-disable-line fenced-code-language -->
```text
{% raw %}{%- ifversion fpt %}{% endraw %}
```
For example, to version a table row, instead of adding liquid versioning for the row starting at the end of the previous row, like this:
``` <!-- markdownlint-disable-line fenced-code-language -->
```markdown
Column A | Column B | Column C
---------|----------|---------
This row is for all versions | B1 | C1{% raw %}{% ifversion ghes %}{% endraw %}
@@ -178,7 +178,7 @@ This row is for all versions | B3 | C3
You can include the liquid versioning on its own line and use whitespace control to strip the newline to the left of the liquid tag. This makes reading the source much easier, without breaking the rendering of the table:
``` <!-- markdownlint-disable-line fenced-code-language -->
```markdown
Column A | Column B | Column C
---------|----------|---------
This row is for all versions | B1 | C1
@@ -322,4 +322,4 @@ Sometimes a change isn't included in the release it was originally intended for.
### Test, test, and test again
Whether you're writing the content or reviewing the content, pay attention to the content design plan and affected products, and check the rendered content in a staging or development environment to ensure that the content describes each product accurately.
Whether you're writing the content or reviewing the content, pay attention to the content design plan and affected products, and check the rendered content in a staging or development environment to ensure that the content describes each product accurately.