Markdown-Navbar —— 多是最好用的markdown文章导航组件

这多是最实用的markdown文章结构树组件,使用此组件,你能够:
  • 为读者显示文章目录
  • 点击目录跳转到文章对应内容
  • 分享带锚点hash值的url给读者
Best markdown navigation bar for React.

git repocss

Install

yarn add markdown-navbar

orgit

npm install markdown-navbar

Usage

import MarkNav from 'markdown-navbar';
import 'markdown-navbar/dist/navbar.css';

const content = '## Heading One...\n\n## Heading Two...\n';

<MarkNav
  className="article-menu"
  source={content}
  headingTopOffset={80}
/>

Screenshots

Screenshots

Options

property type default value use
className string "" The className that defines the outermost container of navbar
source string "" Markdown text content
headingTopOffset number 0 Anchor relative to the top of the window displacement (for the anchor jump)
ordered boolean true Whether the title contains a numerical prefix, such as: 1. 2. 2.2

License

Markdown-Navbar is released under the MIT license.github

相关文章
相关标签/搜索