@vegaprotocol/docusaurus-theme-github-codeblock
TypeScript icon, indicating that this package has built-in type declarations

0.1.8 • Public • Published

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:

Plugin Example


If you are interested contributing to this project, see CONTRIBUTING.md.

See also

Readme

Keywords

Package Sidebar

Install

npm i @vegaprotocol/docusaurus-theme-github-codeblock

Weekly Downloads

55

Version

0.1.8

License

MIT

Unpacked Size

22.1 kB

Total Files

21

Last publish

Collaborators

  • dexturr
  • curly42
  • eddhannay
  • vega-bot