Skip to content

Commit

Permalink
Specify when defaultTool for the tool selector is not used (github#…
Browse files Browse the repository at this point in the history
…23940)

Co-authored-by: Vanessa <[email protected]>
  • Loading branch information
skedwards88 and vgrl authored Dec 21, 2021
1 parent 8e592aa commit 88927ec
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion content/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ defaultPlatform: linux

### `defaultTool`

- Purpose: Override the initial tool selection for a page, where tool refers to the application the reader is using to work with GitHub (such as GitHub.com's web UI, the GitHub CLI, or GitHub Desktop) or the GitHub APIs (such as cURL or the GitHub CLI). If this frontmatter is omitted, then the tool-specific content matching the GitHub web UI is shown by default. This behavior can be changed for individual pages, for which a manual selection is more reasonable.
- Purpose: Override the initial tool selection for a page, where tool refers to the application the reader is using to work with GitHub (such as GitHub.com's web UI, the GitHub CLI, or GitHub Desktop) or the GitHub APIs (such as cURL or the GitHub CLI). For more information about the tool selector, see [Markup reference for GitHub Docs](../contributing/content-markup-reference.md#tool-tags). If this frontmatter is omitted, then the tool-specific content matching the GitHub web UI is shown by default. If a user has indicated a tool preference (by clicking on a tool tab), then the user's preference will be applied instead of the default value.
- Type: `String`, one of: `webui`, `cli`, `desktop`, `curl`, `codespaces`, `vscode`.
- Optional.

Expand Down

0 comments on commit 88927ec

Please sign in to comment.