Embeding GitHub gist into Docusaurus v2 docs

Question

I'm new to Docusaurus and wonder is there a way to embed GitHub gists into docusaurus docs?

I found this module: https://github.com/winoteam/docusaurus-gist-embed but I don't seem to get it to work.

jeffreyaven · Accepted Answer · 2021-06-01 10:26:20Z

2

Easy one, install this package in your Docusaurus project

the in your markdown add the import statement along with a Gist JSX code with your Gist id as shown below:

---
title: yourtitle
---
import Gist from 'react-gist';

<Gist id="9b9985dbf8163ade22b71f2ccf20cb51" 
/>

answered Jun 1, 2021 at 10:26

jeffreyaven

2462 silver badges6 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Sebastien Lorber · Accepted Answer · 2020-08-20 18:02:53Z

0

Docusaurus 2 is based on MDX so any react component you put in the markdown should render, including an iframe with a gist or whatever you want.

answered Aug 20, 2020 at 18:02

Sebastien Lorber

92.6k76 gold badges302 silver badges431 bronze badges