diff --git a/content/issues/tracking-your-work-with-issues/about-slash-commands.md b/content/issues/tracking-your-work-with-issues/about-slash-commands.md new file mode 100644 index 0000000000..7632bf6e82 --- /dev/null +++ b/content/issues/tracking-your-work-with-issues/about-slash-commands.md @@ -0,0 +1,33 @@ +--- +title: About slash commands +intro: 'Slash commands can save you time by reducing the typing required to create complex Markdown.' +versions: + feature: slash-commands +redirect_from: + - /early-access/issues/about-slash-commands +--- + +{% note %} + +**Note:** Slash commands are currently in public beta and subject to change. + +{% endnote %} + +## About slash commands + +Slash commands make it easier to type more complex Markdown, such as tables, tasklists, and code blocks. + +You can use slash commands in any description or comment field in issues, pull requests, or discussions where that slash command is supported. + +## Using slash commands + +You can use slash commands by typing the command in a comment field, then following the prompts. To insert complex Markdown into your comment, type one of the following commands. + +| Command | Description | +| ------- | ----------- | +| `/code` | Inserts a Markdown code block. You choose the language. +| `/details` | Inserts a collapsable detail area. You choose the title and content. +| `/saved-replies` | Inserts a saved reply. You choose from the saved replies for your user account. If you add `%cursor%` to your saved reply, the slash command will place the cursor in that location. +| `/table` | Inserts a Markdown table. You choose the number of columns and rows. +| `/tasklist` | Inserts a Tasklist. This slash command only works in an issue description. {% note %} **Note:** Tasklists are currently in private beta and may not be available to all users. For more information, see "[About Tasklists](/issues/tracking-your-work-with-issues/about-tasklists)." {% endnote %} +| `/template` | Shows all of the templates in the repository. You choose the template to insert. This slash command will work for issue templates and a pull request template. diff --git a/content/issues/tracking-your-work-with-issues/index.md b/content/issues/tracking-your-work-with-issues/index.md index 2d5015d86e..35ded768b7 100644 --- a/content/issues/tracking-your-work-with-issues/index.md +++ b/content/issues/tracking-your-work-with-issues/index.md @@ -14,6 +14,7 @@ children: - /quickstart - /creating-an-issue - /about-tasklists + - /about-slash-commands - /linking-a-pull-request-to-an-issue - /creating-a-branch-for-an-issue - /assigning-issues-and-pull-requests-to-other-github-users @@ -29,4 +30,3 @@ redirect_from: - /issues/tracking-your-work-with-issues/creating-issues - /issues/tracking-your-work-with-issues/managing-issues --- - diff --git a/data/features/slash-commands.yml b/data/features/slash-commands.yml new file mode 100644 index 0000000000..4bc7ee04bd --- /dev/null +++ b/data/features/slash-commands.yml @@ -0,0 +1,4 @@ +# Reference: #9844 +# Slash Commands (Public Beta) +versions: + fpt: '*'