Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

y-markdown

ylvfeng6ISC0.0.13

render markdown in browser

markdown

readme

[TOC]

用来做什么?

通过React组件的方式调用,将markdown文件内容转换为html渲染【内置了一套样式】。

用法

const App = ()=>{
    return <Markdown onMarked={h => console.log('html',h)}>
        {require('./测试文档.md').default}
    </Markdown>;
};

API

  • children {string} markdown文档内容
  • className 符合clsx方法接口的参数都可以,通常是string
  • style {object}
  • onMarked {function}