Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/rude-jeans-explain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@studiocms/markdown-remark": patch
---

update readme
3 changes: 0 additions & 3 deletions README.md

This file was deleted.

1 change: 1 addition & 0 deletions README.md
18 changes: 17 additions & 1 deletion packages/markdown-remark/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# @studiocms/markdown-remark

[![NPM Version](https://img.shields.io/npm/v/@studiocms/markdown-remark?style=for-the-badge&logo=npm)](https://npm.im/@studiocms/markdown-remark)
[![Formatted with Biome](https://img.shields.io/badge/Formatted_with-Biome-60a5fa?style=for-the-badge&logo=biome)](https://biomejs.dev/)
[![Built with Astro](https://img.shields.io/badge/built_with-astro-astro?style=for-the-badge&logo=astro&logoColor=fff&color=%23BC52EE)](https://astro.build)

## Overview

`@studiocms/markdown-remark` is a powerful Markdown parser and transformer built on top of [remark](https://github.com/remarkjs/remark). It provides seamless integration with [Astro](https://astro.build/), allowing you to easily parse and transform Markdown content within your Astro projects.
Expand Down Expand Up @@ -155,4 +159,16 @@ const content = await render("# Hello World!")
{content.html}
</body>
</html>
```
```

## Changelog

See the [Changelog](https://github.com/withstudiocms/markdown-remark/blob/main/packages/markdown-remark/CHANGELOG.md) for the change history of this package.

## Contribution

If you see any errors or room for improvement, feel free to open an [issues or pull request](https://github.com/withstudiocms/markdown-remark/) . Thank you in advance for contributing! ❤️

## Licensing

[MIT Licensed](./LICENSE).
Loading