A lightweight and extensible Markdown library for transforming and building Markdown with a deterministic and specification-oriented approach.
npm install @ogs-gmbh/markdown> We're OGS, check out our work on github.com/ogs-gmbh
A lightweight and extensible Markdown library for transforming and building Markdown with a deterministic and specification-oriented approach.
- AST-Based Serialization\
Converts Markdown into valid Markdown.
- Programmatic Builder API\
Enables deterministic, type-safe construction of Markdown documents.
- Semantic-Preserving Transformations
Allows structural modifications without altering the intended meaning.
- Extensibility\
Supports common Markdown extensions (e.g., tables, task lists).
We support all available elements in flavors:
- GitHub
- markdown-it
- Vitepress
> [!IMPORTANT]
> We're offering an extensive API-Reference covered with in-depth usage examples of this project.
To get a starting point, simply refer to our documentation at ogs-gmbh.github.io/markdown.
- Node.js version 18 or higher.
- A package manager: e.g. npm, pnpm, ...
Using npm:
``sh`
$ npm install @ogs-gmbh/markdown
Using a different package managers?
Using yarn:
`sh`
$ pnpm add @ogs-gmbh/markdown
`
Using pnpm:
sh`
$ pnpm add @ogs-gmbh/markdown
`
Using bun:
sh`
$ bun add @ogs-gmbh/markdown
Markdown can now be easily build. But make sure to import it first with your Markdown elements.
`ts``
import { define } from "@ogs-gmbh/markdown";
Now you can start adding Markdown elements. Each element has an example. Just check it out at ogs-gmbh.github.io/markdown/reference.
The MIT License (MIT) - Please have a look at the LICENSE file for more details.
Feel free to submit a pull request, issue or feature request.
You can create a new issue or feature request here.
You can find the guidelines here.
All trademarks and registered trademarks mentioned are property of their respective owners and are used for identification purposes only. Use of these names does not imply endorsement or affiliation.
This project is a trademark of OGS Gesellschaft für Datenverarbeitung und Systemberatung mbH. The License does not grant rights to use the trademark without permission.
---
Gesellschaft für Datenverarbeitung und Systemberatung mbH