A Docusaurus v2 plugin that supports referencing code examples from public GitHub repositories.
npm install @saucelabs/theme-github-codeblockDocusaurus Theme GitHub Codeblock !Test Changes
=================================
A Docusaurus v2 plugin that supports referencing code examples from public GitHub repositories.
> Note: this theme plugin requires Docusaurus v2
First, add the theme plugin to your dependencies:
``shNPM
npm install --save @saucelabs/theme-github-codeblock
Usage
Add the theme plugin to your list of themes in the
docusaurus.config.js:`js
// ...
themes: [
'@saucelabs/theme-github-codeblock'
],
// ...
`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.:
`js reference
https://github.com/saucelabs/docusaurus-theme-github-codeblock/blob/main/src/theme/ReferenceCodeBlock/index.tsx#L105-L108
`You can also set a custom title:
`js reference title="Example"
https://github.com/saucelabs/docusaurus-theme-github-codeblock/blob/main/src/theme/ReferenceCodeBlock/index.tsx#L105-L108
``The plugin will download the code and display the desired lines:
---
If you are interested contributing to this project, see CONTRIBUTING.md.