simple-markdown-preview v0.0.9

simple-markdown-preview

简化markdown文档预览代码

使用

import { SimplePreview } from "simple-markdown-preview"

案例

import React from "react"
import { SimplePreview } from "simple-markdown-preview"

const Demo = ()=>{

  return (<SimplePreview path={() => import("simple-markdown-preview/README.md")} />)

}

export default Demo;

import React from "react"
import { SimplePreview } from "simple-markdown-preview"

const Demo = ()=>{

  return (<div>案例</div>)

}

export default Demo;

参数

export interface HandleMetaDataReturn {
  /**react-code-preview-layout 组件属性*/
  layout?: Record<string, string>
  /**react-code-preview-layout Preview 组件属性*/
  preview?: Record<string, string>
  /**react-code-preview-layout Code 组件属性*/
  code?: Record<string, string>
  /**react-code-preview-layout Toolbar 组件属性*/
  toolbar?: Record<string, string>
}

export interface SimplePreviewProps {
  /**加载文档地址*/
  path: MdDataHandle,
  /**处理数值*/
  handleMetaData?: (value: Record<string, string>) => HandleMetaDataReturn
  /**底部内容区域*/
  footer?: React.ReactNode
  /**回到顶部操作按钮*/
  backToUpProps?: Omit<BackToUpProps, "element">
  /**
   * 回到顶部操作按钮监听滚动节点
  */
  backToUpElement?: boolean | HTMLElement
  /** @uiw/react-markdown-preview 组件中components参数 */
  components?: Options['components']
}