@ogs-gmbh/markdown
v1.1.5TypeScript
A lightweight and extensible Markdown library for transforming and building Markdown with a deterministic and specification-oriented approach.
191/weekUpdated 6 days agoMITUnpacked: 60.2 KB
Published by OGS GmbH
npm install @ogs-gmbh/markdown> We're OGS, check out our work on github.com/ogs-gmbh
Markdown
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).
Supported Flavors
We support all available elements in flavors:
- GitHub
- markdown-it
- Vitepress
Getting Started
> [!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.
Prerequisites
- Node.js version 18 or higher.
- A package manager: e.g. npm, pnpm, ...
Installation
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
Building
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.
License
The MIT License (MIT) - Please have a look at the LICENSE file for more details.
Contributing
Contributions are always welcome and greatly appreciated. Whether you want to report a bug, suggest a new feature, or improve the documentation, your input helps make the project better for everyone.
Feel free to submit a pull request, issue or feature request.
$3
Reporting an issue or creating a feature request is made by creating a new issue on this repository.
You can create a new issue or feature request here.
$3
GitHub offers a solid guideline for contributing to open source projects through pull requests, covering key practices. These best practices provide a reliable starting point for making effective contributions.
You can find the guidelines here.
$3
We are committed to keeping a welcoming, inclusive, and respectful community for everyone. To help us achieve this, we kindly ask that you adhere to our Code of Conduct.
Disclaimer
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