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

Add content model for the tool switcher (#31393)

Browse Source
This commit is contained in:
Ethan Palm
2022-10-10 13:37:06 -07:00
committed by GitHub
parent 47f50524b8
commit d524cda72b
3 changed files with 47 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -129,9 +129,11 @@ You can define a default platform in the frontmatter. For more information, see
## Tool tags
We occasionally need to write documentation for different tools (GitHub UI, GitHub CLI, GitHub Desktop, cURL, Codespaces, VS Code, GitHub Enterprise Importer CLI, GraphQL API). Each tool may require a different set of instructions. We use tool tags to demarcate information for each tool. To modify the list of possible tools, edit [`lib/all-tools.js`](../lib/all-tools.js).
We occasionally need to write documentation for different tools (GitHub UI, GitHub CLI, GitHub Desktop, cURL, Codespaces, VS Code, GitHub Enterprise Importer CLI, GraphQL API). Each tool may require a different set of instructions. We use tool tags to demarcate information for each tool.
To add a new tool, add an entry to the `allTools` object in `lib/all-tools.js` as a key-value pair. The key is the tag you'll use to refer to the tool in the article, the value is how the tool will be identified on the tool picker at the top of the article.
On rare occasions, we will add new tools. Before adding a new tool, read the [tool switcher content model](./tool-switcher.md). To add a new tool, add an entry to the `allTools` object in [`lib/all-tools.js`](../lib/all-tools.js) as a key-value pair. The key is the tag you'll use to refer to the tool in the article, the value is how the tool will be identified on the tool picker at the top of the article.
You can define a default tool in the frontmatter. For more information, see the [content README](../content/README.md#defaulttool).
### Usage
@@ -223,8 +225,6 @@ These instructions are pertinent to javascript users.
{% endjavascript %}
```
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.