Git Product home page Git Product logo

remark-mdx-rakkas's Introduction

remark-mdx-rakkas

This is a fork of remark-mdx-frontmatter that is made to work nicely with Rakkas

Installation

First, install this package, along with remark-frontmatter, which it relies on.

npm install remark-frontmatter @trevorblades/remark-mdx-rakkas

In your Rakkas config, you should have a standard-looking MDX configuration, using a Vite plugin and adding mdx to your array of pageExtensions. Pass this module and the remarkFrontmatter to your MDX plugin as the remarkPlugins option.

import mdx from '@cyco130/vite-plugin-mdx';
import {remarkMdxRakkas} from '@trevorblades/remark-mdx-rakkas';
import remarkFrontmatter from 'remark-frontmatter';

export default {
  pageExtensions: ['jsx', 'tsx', 'mdx'],
  vite: {
    plugins: [
      mdx({
        remarkPlugins: [remarkFrontmatter, remarkMdxRakkas]
      })
    ]
  }
}

Usage

This remark plugin takes frontmatter content, and makes it available to your layout components in Rakkas. Both YAML and TOML frontmatter data are supported.

For example, given a file named page.mdx with the following contents:

---
title: Getting started
---

This is how you get started...

<InteractiveComponent />

The following component, layout.jsx can read its child pages' frontmatter by accessing the meta prop.

import {Helmet} from 'react-helmet-async';

export default function Layout({children, meta}) {
  <>
    <Helmet title={meta.title}>
      <meta content={meta.description} name="description" />
    </Helmet>
    <h1>{meta.title}</h1>
    {children}
  </>
}

remark-mdx-rakkas's People

Contributors

remcohaszing avatar trevorblades avatar yordis avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.