English
Español

md Plugin

Overview

Adds capability to render markdown files as html. It also ships with a compact version of prism.js to highlight code snippets.

Usage

In the application's scully.your-app.config.file:

  1. Enable the highlight option by adding the following:
setPluginConfig('md', { enableSyntaxHighlighting: true });
  1. Import any extra language support, if you require it:
/** this line goes into your scully.<app>.config.ts */
import 'prismjs/components/prism-java.js';
  1. Import your desired theme in the application's styles.css:
/* include CSS for prism toolbar */
@import '~prismjs/plugins/toolbar/prism-toolbar.css';
/* check node_modules/prismjs/themes/ for the available themes */
@import '~prismjs/themes/prism-tomorrow';

e.g.

// scully.your-app.config.ts

import { setPluginConfig, ScullyConfig } from '@scullyio/scully';
import 'prismjs/components/prism-java.js'; // example language support

export const config: ScullyConfig = {
  routes: {
    '/blog/:slug': {
      type: 'contentFolder',
      slug: {
        folder: './blog',
      },
    },
  },
};

Visit prismjs for more information.