作者:稚气忖托气质_844 | 来源:互联网 | 2023-08-16 07:48
这多是最有用的markdown文章构造树组件,运用此组件,你能够:为读者显现文章目次点击目次跳转到文章对应内容分享带锚点hash值的url给读者Bestmarkdownnaviga
这多是最有用的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';
className="article-menu"
source={content}
headingTopOffset={80}
/>
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.