{"id":35668781,"url":"https://github.com/ogs-gmbh/markdown","last_synced_at":"2026-02-03T14:08:02.509Z","repository":{"id":328973776,"uuid":"1116713870","full_name":"OGS-GmbH/markdown","owner":"OGS-GmbH","description":"A lightweight and extensible npm library for parsing, transforming, and rendering Markdown with a deterministic and specification-oriented approach.","archived":false,"fork":false,"pushed_at":"2026-01-16T08:36:05.000Z","size":213,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-17T05:09:12.374Z","etag":null,"topics":["markdown","markdown-builder","markdown-library","typescript","typescript-library"],"latest_commit_sha":null,"homepage":"https://ogs-gmbh.github.io/markdown/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OGS-GmbH.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-15T09:22:27.000Z","updated_at":"2026-01-13T10:21:25.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/OGS-GmbH/markdown","commit_stats":null,"previous_names":["ogs-gmbh/markdown"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/OGS-GmbH/markdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OGS-GmbH%2Fmarkdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OGS-GmbH%2Fmarkdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OGS-GmbH%2Fmarkdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OGS-GmbH%2Fmarkdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OGS-GmbH","download_url":"https://codeload.github.com/OGS-GmbH/markdown/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OGS-GmbH%2Fmarkdown/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29047278,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-03T10:09:22.136Z","status":"ssl_error","status_checked_at":"2026-02-03T10:09:16.814Z","response_time":96,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","markdown-builder","markdown-library","typescript","typescript-library"],"created_at":"2026-01-05T18:12:41.725Z","updated_at":"2026-02-03T14:08:02.499Z","avatar_url":"https://github.com/OGS-GmbH.png","language":"TypeScript","readme":"\u003e *We're OGS, check out our work on [github.com/ogs-gmbh](https://github.com/ogs-gmbh)*\n\n# Markdown\n\n*A lightweight and extensible Markdown library for transforming and building Markdown with a deterministic and specification-oriented approach.* \n\n![Preview](./docs/preview.avif)\n\n\u003ca href=\"./LICENSE\" target=\"_blank\"\u003e\u003cimg alt=\"license badge\" src=\"https://img.shields.io/github/license/OGS-GmbH/markdown?color=0f434e\u0026logo=hackthebox\u0026logoColor=000000\u0026labelColor=ffffff\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/OGS-GmbH/markdown/actions/workflows/main-deploy.yml\" target=\"_blank\"\u003e\u003cimg alt=\"workflow badge\" src=\"https://img.shields.io/github/actions/workflow/status/OGS-GmbH/markdown/main-deploy.yml?color=0f434e\u0026logo=rocket\u0026logoColor=000000\u0026labelColor=ffffff\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://www.npmjs.com/package/@ogs-gmbh/markdown\" target=\"_blank\"\u003e\u003cimg alt=\"npm badge\" src=\"https://img.shields.io/npm/v/%40ogs-gmbh%2Fmarkdown?color=0f434e\u0026logo=npm\u0026logoColor=000000\u0026labelColor=ffffff\" /\u003e\u003c/a\u003e\n\n- **AST-Based Serialization**\\\n  Converts Markdown into valid Markdown.\n\n- **Programmatic Builder API**\\\n  Enables deterministic, type-safe construction of Markdown documents.\n\n- **Semantic-Preserving Transformations**\n  Allows structural modifications without altering the intended meaning.\n\n- **Extensibility**\\\n  Supports common Markdown extensions (e.g., tables, task lists).\n\n## Supported Flavors\n\nWe support all available elements in flavors:\n\n- GitHub\n- markdown-it\n- Vitepress\n\n## Getting Started\n\n\u003e [!IMPORTANT]\n\u003e We're offering an extensive API-Reference covered with in-depth usage examples of this project.\n\nTo get a starting point, simply refer to our documentation at [ogs-gmbh.github.io/markdown](https://ogs-gmbh.github.io/markdown).\n\n## Prerequisites\n\n- Node.js version 18 or higher.\n- A package manager: e.g. npm, pnpm, ...\n\n## Installation\n\nUsing npm:\n```sh\n$ npm install @ogs-gmbh/markdown\n```\n\n\u003cdetails\u003e\n  \u003csummary\u003eUsing a different package managers?\u003c/summary\u003e\n  \u003cbr/\u003e\n  \n  Using yarn:\n  ```sh\n  $ pnpm add @ogs-gmbh/markdown\n  ```\n  \n  Using pnpm:\n  ```sh\n  $ pnpm add @ogs-gmbh/markdown\n  ```\n  \n  Using bun:\n  ```sh\n  $ bun add @ogs-gmbh/markdown\n  ```\n\n\u003c/details\u003e\n\n## Building\n\nMarkdown can now be easily build. But make sure to import it first with your Markdown elements.\n\n```ts\nimport { define } from \"@ogs-gmbh/markdown\";\n```\n\nNow 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/).\n\n## License\n\nThe MIT License (MIT) - Please have a look at the [LICENSE file](./LICENSE) for more details.\n\n## Contributing\nContributions 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.\n\nFeel free to submit a pull request, issue or feature request.\n\n### Issues and Feature Requests\nReporting an issue or creating a feature request is made by creating a new issue on this repository.\n\nYou can create a [new issue or feature request here](../../issues/new/choose).\n\n### Pull Requests\nGitHub 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.\n\nYou can find the [guidelines here](https://docs.github.com/get-started/exploring-projects-on-github/contributing-to-a-project).\n\n### Code Of Conduct\nWe 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).\n\n## Disclaimer\n\nAll 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.\n\nThis 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.\n\n---\n\n\u003ca href=\"https://www.ogs.de/en/\"\u003e\n  \u003cpicture\u003e\n    \u003csource\n      srcset=\"https://raw.githubusercontent.com/OGS-GmbH/.github/refs/tags/v1.0.0/docs/assets/logo/light.svg\"\n      media=\"(prefers-color-scheme: dark)\"\n    /\u003e\n    \u003cimg height=\"64\" alt=\"OGS Logo\" src=\"https://raw.githubusercontent.com/OGS-GmbH/.github/refs/tags/v1.0.0/docs/assets/logo/dark.svg\"\n  \u003c/picture\u003e\n\u003c/a\u003e\n\n\u003cp\u003eGesellschaft für Datenverarbeitung und Systemberatung mbH\u003c/p\u003e\n\n[Imprint](https://www.ogs.de/en/imprint/) | [Contact](https://www.ogs.de/en/contact/) | [Careers](https://www.ogs.de/en/about-ogs/#Careers)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fogs-gmbh%2Fmarkdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fogs-gmbh%2Fmarkdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fogs-gmbh%2Fmarkdown/lists"}