@studiocms/markdown-remark
v1.2.0
Published
[](https://npm.im/@studiocms/markdown-remark) [
Readme
@studiocms/markdown-remark
Overview
@studiocms/markdown-remark is a powerful Markdown parser and transformer built on top of remark. It provides seamless integration with Astro, allowing you to easily parse and transform Markdown content within your Astro projects.
This project is heavily based on and compatible with Astro's built-in @astrojs/markdown-remark
Features
- Markdown Parsing: Parse Markdown content into an abstract syntax tree (AST) using remark.
- Astro Integration: Easily integrate with Astro to transform Markdown content into HTML.
- Custom Plugins: Extend the functionality with custom remark plugins.
- Configurable: Highly configurable to suit your specific needs.
Installation
To install @studiocms/markdown-remark, use your preferred package manager:
npm install @studiocms/markdown-remark
# or
yarn add @studiocms/markdown-remark
# or
pnpm add @studiocms/markdown-remarkUsage
As an Astro Integration
With the Astro integration enabled, you can either pass in custom components into your astro config, or manually for the specific render your trying to do shown in the following methods.
Setup the integration
astro.config.mjs
import markdownRemark from '@studiocms/markdown-remark';
import { defineConfig } from 'astro/config';
export default defineConfig({
markdown: {
/*
* Your Customizations here based on:
* https://docs.astro.build/en/reference/configuration-reference/#markdown-options
*/
},
integrations: [markdownRemark({
// Used for injecting CSS for Headings and Callouts
injectCSS: true,
// User defined components that will be used when processing markdown
components: {
// Example of a custom defined component
custom: "./src/components/Custom.astro",
},
// Custom Markdown config
markdown: {
// Configure the available callout themes
callouts: {
theme: 'obsidian' // Can also be 'github' or 'vitepress'
},
autoLinkHeadings: true,
sanitize: {} // see https://github.com/natemoo-re/ultrahtml?tab=readme-ov-file#sanitization for full options
}
})],
});Use the integration
src/pages/index.astro
---
import { Markdown } from 'studiocms:markdown-remark';
import Custom from '../components/Custom.astro';
---
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width" />
<title>Example</title>
</head>
<body>
<Markdown content={`# Hello World! <custom></custom>`} components={{ custom: Custom }} />
</body>
</html>OR
---
import { render } from 'studiocms:markdown-remark';
import Custom from '../components/Custom.astro';
// @ts-ignore
const { html } = await render('# Hello World! <custom></custom>', {}, { $$result, {custom: Custom} })
---
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width" />
<title>Example</title>
</head>
<body>
{html}
</body>
</html>Using the Markdown component directly without the integration
src/pages/index.astro
---
import { Markdown } from '@studiocms/markdown-remark/components';
import H1 from '../components/H1.astro';
---
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width" />
<title>Example</title>
</head>
<body>
<Markdown content={`# Hello world!`} components={{ h1: H1 }} />
</body>
</html>Changelog
See the Changelog for the change history of this package.
Contribution
If you see any errors or room for improvement, feel free to open an issue or pull request . Thank you in advance for contributing! ❤️