rpf-markdown

JS library to parse markdown and return HTML.

Current features

• Code blocks formatted using prism JS
• projects site custom blocks like task, tip and debug
• scratchblocks
• Raspberry Flavoured Markdown as outlined in this spec

Add to your project

Install the package from npm using Yarn or npm:

yarn add @raspberrypifoundation/rpf-markdown-core

npm install @raspberrypifoundation/rpf-markdown-core

Example usage

import { processEditorProject } from "@raspberrypifoundation/rpf-markdown-core";

// processEditorProject returns the HTML for the markdown passed into it.
const exampleMarkdown = `# Hello World`;
const htmlOutput = processEditorProject(exampleMarkdown);

// Some options are available:
// Force high contrast mode for Scratch blocks in the markdown (Scratch 3 blocks only)
const htmlOutput2 = processEditorProject(someMarkdownWithScratch3Blocks, {scratchblocks: { highContrast: true }});
// Scale the Scratch blocks (default 1; must be a positive number)
const htmlOutput3 = processEditorProject(someMarkdownWithScratchBlocks, {scratchblocks: { scale: 1.5 }});

Development setup

This project uses the Node version specified in .tool-versions. Node is managed by asdf. Yarn is provided by Corepack, which selects the version specified by packageManager in package.json.

Node and Yarn setup

asdf install
corepack enable
asdf reshim nodejs
yarn --version

Install dependencies

yarn install

Run the build in watch mode

yarn dev

Test unreleased changes locally

Create a package archive from this repository. The prepack script builds the library automatically:

yarn pack --out rpf-markdown-core.tgz

Then install the archive in the target project:

yarn add @raspberrypifoundation/rpf-markdown-core@file:/path/to/rpf-markdown-core.tgz

Releasing a new version

1. Create a new PR to bump the version in package.json.
2. Merge the PR.
3. Create a new GitHub Release with a tag matching the version in package.json.
4. The package will be published automatically to npm and GitHub Packages.