Gettings started

Installation

Prerequisites

• Node.js version 18 or higher.
• A package manager: e.g. npm, pnpm, ...

npm

$ npm add -D @ogs-gmbh/markdown

pnpm

$ pnpm add -D @ogs-gmbh/markdown

yarn

$ yarn add -D @ogs-gmbh/markdown

bun

$ bun add -D @ogs-gmbh/markdown

Usage

We support all available elements in flavors:

• ✅ GitHub
• ✅ markdown-it
• ✅ Vitepress

Check the reference. Each element is shipped with an example.