Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

repo sync #593

Merged
merged 1 commit into from
Oct 16, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/actions/guides/building-and-testing-nodejs.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ We recommend that you have a basic understanding of Node.js, YAML, workflow conf
To get started quickly, add the template to the `.github/workflows` directory of your repository.

{% raw %}
```yaml
```yaml{:copy}
name: Node.js CI

on: [push]
Expand Down
2 changes: 1 addition & 1 deletion content/actions/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You only need an existing {% data variables.product.prodname_dotcom %} repositor
1. From your repository on {% data variables.product.prodname_dotcom %}, create a new file in the `.github/workflows` directory named `superlinter.yml`. For more information, see "[Creating new files](/github/managing-files-in-a-repository/creating-new-files)."
2. Copy the following YAML contents into the `superlinter.yml` file. **Note:** If your default branch is not `main`, update the value of `DEFAULT_BRANCH` to match your repository's default branch name.
{% raw %}
```yaml
```yaml{:copy}
name: Super-Linter

# Run this workflow every time a new commit pushed to your repository
Expand Down
14 changes: 11 additions & 3 deletions contributing/content-markup-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,22 @@ To render syntax highlighting in command line instructions, we use triple backti

### Usage

\`\`\`shell
git init <em>YOUR_REPO</em>
\`\`\`
```shell
git init <em>YOUR_REPO</em>
```

This syntax highlighting renders light text on a dark background, and should be reserved for command line instructions.

Within the command-line syntax, you can also use the `<em>` helper tag to indicate 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](https://primer.style/octicons). For accessibility purposes, use [the `aria-label` option](https://primer.style/octicons/packages/javascript#aria-label) to describe the Octicon.
Expand Down
15 changes: 15 additions & 0 deletions javascripts/copy-code.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import Clipboard from 'clipboard'

export default () => {
const clipboard = new Clipboard('button.js-btn-copy')

clipboard.on('success', evt => {
const btn = evt.trigger
const beforeTooltip = btn.getAttribute('aria-label')
btn.setAttribute('aria-label', 'Copied!')

setTimeout(() => {
btn.setAttribute('aria-label', beforeTooltip)
}, 2000)
})
}
2 changes: 2 additions & 0 deletions javascripts/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import print from './print'
import localization from './localization'
import helpfulness from './helpfulness'
import experiment from './experiment'
import copyCode from './copy-code'
import { fillCsrf } from './get-csrf'
import initializeEvents from './events'

Expand All @@ -31,5 +32,6 @@ document.addEventListener('DOMContentLoaded', async () => {
await fillCsrf() // this must complete before any POST calls
helpfulness()
experiment()
copyCode()
initializeEvents()
})
152 changes: 128 additions & 24 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"@babel/runtime": "^7.11.2",
"@github-docs/data-directory": "^1.2.0",
"@github-docs/frontmatter": "^1.3.1",
"@github-docs/render-content": "^5.0.0",
"@github-docs/render-content": "^5.1.0",
"@github/rest-api-operations": "^3.1.3",
"@octokit/rest": "^16.38.1",
"@primer/css": "^15.1.0",
Expand All @@ -26,6 +26,7 @@
"browser-date-formatter": "^3.0.3",
"change-case": "^3.1.0",
"cheerio": "^1.0.0-rc.3",
"clipboard": "^2.0.6",
"compression": "^1.7.4",
"connect-slashes": "^1.4.0",
"cookie-parser": "^1.4.5",
Expand Down
Loading