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

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

git repo

Install

yarn add markdown-navbar

or

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

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

Options

propertytypedefault valueuse
classNamestring""The className that defines the outermost container of navbar
sourcestring""Markdown text content
headingTopOffsetnumber0Anchor relative to the top of the window displacement (for the anchor jump)
orderedbooleantrueWhether the title contains a numerical prefix, such as: 1. 2. 2.2

License

Markdown-Navbar is released under the MIT license.

相关推荐