Skip to content

Commit 930d602

Browse files
committed
Add documentation
1 parent d565a13 commit 930d602

1 file changed

Lines changed: 15 additions & 3 deletions

File tree

contributing/content-markup-reference.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,11 @@ Octicons are icons used across GitHub’s interface. We reference Octicons when
6262

6363
### Usage
6464

65-
`{% octicon "<name of octicon>" %}`
66-
`{% octicon "plus" %}`
67-
`{% octicon "plus" aria-label="The plus icon" %}`
65+
```
66+
{% octicon "<name of octicon>" %}
67+
{% octicon "plus" %}
68+
{% octicon "plus" aria-label="The plus icon" %}
69+
```
6870

6971
## Operating system tags
7072

@@ -94,6 +96,16 @@ These instructions are pertinent to Windows users.
9496
{% endlinux %}
9597
```
9698

99+
The platform-specific content matching the reader's operating system shows by default. You can override this behavior for individual Markdown files with the `defaultPlatform` frontmatter (such as for pages about GitHub Actions runners, which mostly use Linux):
100+
101+
```
102+
---
103+
title: …
104+
versions: …
105+
defaultPlatform: linux
106+
---
107+
```
108+
97109
## Reusable and variable strings of text
98110

99111
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.

0 commit comments

Comments
 (0)