gatsby-remark-embed-gist


This plugin allows content authors to embed Gist
snippets.

Getting started

To embed a Gist snippet in you markdown/remark content, simply add an inline code
block using the gist: protocol.

``md
gist:[/]#
gist:[/]#?lines=
gist:[/]#?highlights=
gist:[/]#?highlights=&lines=
gist:[/]?file=
gist:[/]?file=?lines=
gist:[/]?file=?highlights=
gist:[/]?file=?highlights=&lines=
`

Where:

- username, represents the github handler whose gist is to be accessed.
Can be defaulted via configuration.
- gist_id, is the id of the gist to be accessed.
This is the hash value in the gist url, e.g. https://gist.github.com//ce54fdb1e5621b5966e146026995b974).
- gist_file, is the name of the file in the gist to be accessed.

Highlights and lines can be defined using:

- A single number (e.g. highlights=1, lines=1)
- A list of numbers (e.g. highlights=1,4, lines=1,4)
- A range of numbers (e.g. highlights=1-4, lines=1-4)
- A combination of all above (e.g. highlights=1,3,7-9, lines=1,3,7-9)

Installation

yarn add gatsby-remark-embed-gist

Usage

`javascript
// In your gatsby-config.js
{
resolve: "gatsby-transformer-remark",
options: {
plugins: [
{
resolve: "gatsby-remark-embed-gist",
options: {
// Optional:

// the github handler whose gists are to be accessed
username: "",

// a flag indicating whether the github default gist css should be included or not
// default: true
// DEPRECATED (PLEASE USE gistDefaultCssInclude)
includeDefaultCss: true || false,

// a flag indicating whether the github default gist css should be included or not
// default: true
gistDefaultCssInclude: true || false,

// a flag indicating whether the github default gist css should be preloaded or not
// use this if you want to load the default css asynchronously.
// default: false
gistCssPreload: true || false,

// a string that represents the github default gist css url.
// defaults: "https://github.githubassets.com/assets/gist-embed-b3b573358bfc66d89e1e95dbf8319c09.css"
gistCssUrlAddress: ""
}
}
]
}
}
`

Example

Turns this...

`md
gist:weirdpattern/ce54fdb1e5621b5966e146026995b974#syntax.text
`

Into this...

`html