Repository files navigation

Adds stylish cards and syntax highlighting to code blocks in markdown files of yourGatsby website.

The Web Component behind this feature was created for the web editor for presentationsDeckDeckGo.

It is implemented withStencil and usePrism.js under the hood.

The inspiration for the design of the "Macish" cards comes from the amazingcarbon, a tool to create and share beautiful images of your source code, and for the "Ubuntu-ish" from thearticle ofCody Pearce.

Multiple theming options.

No predefined cards but stylable with multipleCSS variables.

• Install
• How to use
  • Configure
  • Load the component
  • Plugin Options
• Language
• Styling
  • Terminal
  • Theme
  • Variables
  • Lines highlighting
• Showcase
• License

npm install --save gatsby-transformer-remark gatsby-remark-highlight-code @deckdeckgo/highlight-code

In order to use this plugin, it should be firstconfigured and thenloaded at runtime.

If you are using "gatsby-transformer-remark", you can add "gatsby-remark-highlight-code" like this:

// In your gatsby-config.jsplugins:[{resolve:`gatsby-transformer-remark`,options:{plugins:[{resolve:`gatsby-remark-highlight-code`,},],},},];

If you are using "gatsby-plugin-mdx", you can add "gatsby-remark-highlight-code" like this:

// In your gatsby-config.jsplugins:[{resolve:`gatsby-plugin-mdx`,options:{extensions:[".mdx",".md"],gatsbyRemarkPlugins:[{resolve:`gatsby-remark-highlight-code`,},],},},];

Load the@deckdeckgo/highlight-code once in one of your pages or components.

For example add the following in the main file of your website, in yourindex.js, or in yourlayout.js, in the template of your blog or simply load it where you need it.

import{defineCustomElementsasdeckDeckGoHighlightElement}from"@deckdeckgo/highlight-code/dist/loader";deckDeckGoHighlightElement();

This plugin supports all languages supported byPrism.js. Nothing particular needs to be specified because the component@deckdeckgo/highlight-code will load them automatically at runtime.

Code blocks are displayed in stylish cards but the behavior could be customized.

Per default, code blocks are going to be displayed incarbon ("Macish like") container.

It is also possible to useubuntu (an Ubuntu-like container) ornone (no window container).

Such settings can be provided in the configuration of the plugin.

// In your gatsby-config.jsplugins:[{resolve:`gatsby-transformer-remark`,options:{plugins:[{resolve:`gatsby-remark-highlight-code`,options:{terminal:"ubuntu",},},],},},];

The terminalcarbon can be themed with a wide range of predefined themes.

These can be tried out in the@deckdeckgo/highlight-code documentation and applied as following:

// In your gatsby-config.jsplugins:[{resolve:`gatsby-transformer-remark`,options:{plugins:[{resolve:`gatsby-remark-highlight-code`,options:{terminal:"carbon",theme:"blackboard",},},],},},];

See the@deckdeckgo/highlight-code documentation for the list of CSS4 styling variables.

Single or multiple lines of code can be highlighted.

The Markdown syntax is the following: next to the specification of the language, between brackets{}, the lines should be provided in a comma separated list. A single line can be provided (for exampledart{1}) or multiple one, from and to being separated with a dash (for examplejavascript{3-6}). Both single or multiple lines can be mixed (for exampletypescript{2, 3-4, 7, 8-15}).

Animation between the selected highlighted groups can be triggered with the help of methods (see component@deckdeckgo/highlight-code documentation for details).

I (David here) use this plugin in the blog of my personal websitedaviddalbusco.com.

MIT ©David Dal Busco andNicolas Mattia