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.

What did you try to make the module work? – Bandantonio Jun 23 '20 at 09:25 — Bandantonio, Jun 23 '20 at 09:25
Split paragraph with an additional newline – AlBlue Jun 24 '20 at 08:24 — AlBlue, Jun 24 '20 at 08:24

score 2 · Answer 1 · answered Jun 01 '21 at 10:26

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" 
/>

score 0 · Answer 2 · answered Aug 20 '20 at 18:02

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 '20 at 18:02

Sebastien Lorber

2 Answers2