jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Add tabs for cli/desktop/ui (#19071)

Browse Source
This commit is contained in:
Sarah Edwards
2021-05-04 09:53:52 -07:00
committed by GitHub
parent 3d621ba715
commit be8aa2bccb
9 changed files with 182 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
contributing/content-markup-reference.md
View File

@@ -100,6 +100,40 @@ These instructions are pertinent to Windows users.
You can define a default platform in the frontmatter. For more information, see the [content README](../content/README.md#defaultplatform).
## Tool tags
We occasionally need to write documentation for different tools (GitHub UI, GitHub CLI, GitHub Desktop). Each tool may require a different set of instructions. We use tool tags to demarcate information for each tool.
### Usage
```
{% webui %}
These instructions are pertinent to GitHub UI users.
{% endwebui %}
```
```
{% cli %}
These instructions are pertinent to GitHub CLI users.
{% endcli %}
```
```
{% desktop %}
These instructions are pertinent to GitHub Desktop.
{% enddesktop %}
```
Unlike [operating system tags](#operating-system-tags), which will automatically add tabs to select the operating system at the top of the article, you must add `{% include tool-switcher %}` wherever you want to display tabs to select the tool. This allows you to display the tabs at the top of the article or immediately before a relevant section.
You can define a default tool in the frontmatter. For more information, see the [content README](../content/README.md#defaulttool).
## Reusable and variable strings of text
Reusable strings (commonly called content references or conrefs) contain content that’s used in more than one place in our documentation and allow us to change the content in a single location rather than every place the string appears.