@vegaprotocol/docusaurus-theme-github-codeblock
v0.1.8
Published
A Docusaurus v2 plugin that supports referencing code examples from public GitHub repositories.
Downloads
8
Keywords
Readme
Docusaurus Theme GitHub Codeblock ( 🪛 Patched fork)
A Docusaurus v2 plugin that supports referencing code examples from public GitHub repositories.
NOTE: This is a fork of the original project, since it's not maintained anymore. It contains a patch to work with docusaurus v2.0.1
.
Note: this theme plugin requires Docusaurus v2
Install
First, add the theme plugin to your dependencies:
npm install @vegaprotocol/docusaurus-theme-github-codeblocks
Usage
Add the theme plugin to your list of themes in the docusaurus.config.js
:
// ...
themes: [
'@vegaprotocol/docusaurus-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.
See also
- saucelabs/docusaurus-theme-github-codeblock - the original plugin
- bragaz/docusaurus-theme-github-codeblock - fix an incompatibility with docusaurus
v2.0.0-beta.18