Code Monkey home page Code Monkey logo

react-static-markdown's Introduction

Build Status npm version

Markdown files utils for react-static

Install

yarn add -D globby gray-matter mdxc mdx-loader
yarn add react react-static-markdown 

Example usage with mdx-loader

static.config.js

webpack: (config, {defaultLoaders, stage}) => {
  config.resolve.extensions.push('.md');
  config.module.rules = [
    {
      oneOf: [
        {
          test: /\.md$/,
          use: ['mdx-loader'],
        },
        defaultLoaders.cssLoader,
        defaultLoaders.jsLoader,
        defaultLoaders.fileLoader,
      ],
    },
  ];
  return config;
},

Usage

import About from 'content/pages/about.md';

...

<About />

Example usage without mdx-loader

Markdown is transformed to mdx js code string during getRoutes and then evaluated to component.

static.config.js

const getFiles = require('react-static-mdx/getFilesWithMdx');

...

const pages = await getFiles('content/pages/*.md');

Usage

import mdxToComponent from 'react-static-mdx/mdxToComponent';

...

const Page = mdxToComponent(page.contentmdx);

...

<Page {...props} />

License

React Static uses the MIT license. For more information on this license, click here.

react-static-markdown's People

Contributors

tb avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

martiuh

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.