7.6 KiB
Markup reference for GitHub Docs
Table of contents
- Writing in Markdown
- Lists
- Callout tags
- Code sample syntax highlighting
- Octicons
- Operating system tags
- Tool tags
- Reusable and variable strings of text
- Tables with codeblocks
Writing in Markdown
Markdown is a human-friendly syntax for formatting plain text. Our documentation is written with GitHub Flavored Markdown, a custom version of Markdown based on the CommonMark specification, and it is used across GitHub.
This site's Markdown rendering is powered by /lib/render-content, which is in turn built on the remark Markdown processor.
Lists
In a list item, the general rules for additional content after the first paragraph are:
- Images and subsequent paragraphs should each be on their own line and separated by a blank line.
- All subsequent lines in a list item must match up with the first text after the list marker.
Usage
For example, this is the correct way to write list items with multiple paragraphs or objects:
1. Under your repository name, click **Actions**.
This is another paragraph in the list.
1. This is the next item.
Callout tags
Callouts highlight important information that customers need to know. We use standard formatting and colors for different types of callouts: notes, warnings, and danger notices. Use tags before and after the text you’d like included in the callout box.
Usage
{% note %}
**Note:** Owners and administrators can add outside collaborators to a repository.
{% endnote %}
For information on when to use callout tags, see the style guide.
Code sample syntax highlighting
To render syntax highlighting in command line instructions, we use triple backticks followed by the term shell.
Usage
```shell
git init YOUR_REPO
```
This syntax highlighting renders light text on a dark background, and should be reserved for command line instructions.
Within the command-line syntax, use all uppercase text to indicate placeholder text or content that varies for each user, such as a user or repository name.
Copy-able code blocks
You can also add a header that includes the name of the language and a button to copy the contents of the code block:
```js{:copy}
const copyMe = true
```
Octicons
Octicons are icons used across GitHub’s interface. We reference Octicons when documenting the user interface. Find the name of the Octicon on the Octicons site. For accessibility purposes, use the aria-label option to describe the Octicon.
Usage
{% octicon "<name of octicon>" %}
{% octicon "plus" %}
{% octicon "plus" aria-label="The plus icon" %}
Operating system tags
We occasionally need to write documentation for different operating systems. Each operating system may require a different set of instructions. We use operating system tags to demarcate information for each operating system.
Usage
{% mac %}
These instructions are pertinent to Mac users.
{% endmac %}
{% windows %}
These instructions are pertinent to Windows users.
{% endwindows %}
{% linux %}
These instructions are pertinent to Linux users.
{% endlinux %}
You can define a default platform in the frontmatter. For more information, see the content README.
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.
On rare occasions, we will add new tools. Before adding a new tool, read the tool switcher content model. 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.
You can define a default tool in the frontmatter. For more information, see the content README.
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 %}
{% curl %}
These instructions are pertinent to cURL users.
{% endcurl %}
{% 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.
{% endcodespaces %}
{% vscode %}
These instructions are pertinent to VS Code users.
{% endvscode %}
{% importer_cli %}
These instructions are pertinent to GitHub Enterprise Importer CLI users.
{% endimporter_cli %}
{% graphql %}
These instructions are pertinent to GraphQL API users.
{% endgraphql %}
{% powershell %}
These instructions are pertinent to `pwsh` and `powershell` commands.
{% endpowershell %}
{% bash %}
These instructions are pertinent to Bash shell commands.
{% endbash %}
{% javascript %}
These instructions are pertinent to javascript users.
{% endjavascript %}
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.
For longer strings, we use reusables, and for shorter strings, we use variables. For more information about reusables, see the reusables README. For more information about variables, see the variables README.
Tables with codeblocks
Although using tables to contain block items, such as code blocks, is generally discouraged, occasionally it may be appropriate.
Because tables in GitHub Flavored Markdown cannot contain any line breaks or block-level structures, you must use HTML tags to write the table structure.
When HTML tables contain code blocks, the width of the table might exceed the regular width of page content, and then overflow into the area normally containing the mini table of contents.
If this happens, add the following CSS style to the <table> HTML tag:
<table style="table-layout: fixed;">
For a current example of this usage, see the GitHub Actions examples workflow library.