Skip to content

Commit d6a0c5c

Browse files
add more docs
1 parent 23a3ec3 commit d6a0c5c

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to docusaurus-theme-github-codeblock
1+
# Contributing to `docusaurus-theme-github-codeblock`
22

3-
**Thank you for your interest in docusaurus-theme-github-codeblock. Your contributions are highly welcome.**
3+
**Thank you for your interest in `docusaurus-theme-github-codeblock`. Your contributions are highly welcome.**
44

55
There are multiple ways of getting involved:
66

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,16 @@ npm install @saucelabs/theme-github-codeblock
1515

1616
## Usage
1717

18+
Add the theme plugin to your list of themes in the `docusaurus.config.js`:
19+
20+
```js
21+
// ...
22+
themes: [
23+
'@saucelabs/theme-github-codeblock'
24+
],
25+
// ...
26+
```
27+
1828
In order to reference GitHub snippets in your markdown, create code blocks with a `reference` attached to the language meta string and put the link to your GitHub reference in the code block, e.g.:
1929

2030
```js reference

0 commit comments

Comments
 (0)