npm package: @ogs-gmbh/markdown
Description: A lightweight and extensible Markdown library for transforming and building Markdown with a deterministic and specification-oriented approach.
Author: OGS GmbH
Latest version: 1.1.5

> *We're OGS, check out our work on [github.com/ogs-gmbh](https://github.com/ogs-gmbh)*

# Markdown

*A lightweight and extensible Markdown library for transforming and building Markdown with a deterministic and specification-oriented approach.* 

![Preview](./docs/preview.avif)

<a href="./LICENSE" target="_blank"><img alt="license badge" src="https://img.shields.io/github/license/OGS-GmbH/markdown?color=0f434e&logo=hackthebox&logoColor=000000&labelColor=ffffff" /></a>
<a href="https://github.com/OGS-GmbH/markdown/actions/workflows/main-deploy.yml" target="_blank"><img alt="workflow badge" src="https://img.shields.io/github/actions/workflow/status/OGS-GmbH/markdown/main-deploy.yml?color=0f434e&logo=rocket&logoColor=000000&labelColor=ffffff" /></a>
<a href="https://www.npmjs.com/package/@ogs-gmbh/markdown" target="_blank"><img alt="npm badge" src="https://img.shields.io/npm/v/%40ogs-gmbh%2Fmarkdown?color=0f434e&logo=npm&logoColor=000000&labelColor=ffffff" /></a>

- **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](https://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
```

<details>
  <summary>Using a different package managers?</summary>
  <br/>
  
  Using yarn:
  ```sh
  $ pnpm add @ogs-gmbh/markdown
  ```
  
  Using pnpm:
  ```sh
  $ pnpm add @ogs-gmbh/markdown
  ```
  
  Using bun:
  ```sh
  $ bun add @ogs-gmbh/markdown
  ```

</details>

## 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](https://ogs-gmbh.github.io/markdown/reference/).

## License

The MIT License (MIT) - Please have a look at the [LICENSE file](./LICENSE) 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.

### Issues and Feature Requests
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](../../issues/new/choose).

### Pull Requests
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](https://docs.github.com/get-started/exploring-projects-on-github/contributing-to-a-project).

### Code Of Conduct
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](./CODE_OF_CONDUCT.md).

## 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.

---

<a href="https://www.ogs.de/en/">
  <picture>
    <source
      srcset="https://raw.githubusercontent.com/OGS-GmbH/.github/refs/tags/v1.0.0/docs/assets/logo/light.svg"
      media="(prefers-color-scheme: dark)"
    />
    <img height="64" alt="OGS Logo" src="https://raw.githubusercontent.com/OGS-GmbH/.github/refs/tags/v1.0.0/docs/assets/logo/dark.svg"
  </picture>
</a>

<p>Gesellschaft für Datenverarbeitung und Systemberatung mbH</p>

[Imprint](https://www.ogs.de/en/imprint/) | [Contact](https://www.ogs.de/en/contact/) | [Careers](https://www.ogs.de/en/about-ogs/#Careers)