Giter VIP home page Giter VIP logo

markdown-navbar's Introduction

Markdown-Navbar

Best markdown navbar component for React. With this component, you can:

  • Display article directory for readers
  • Click on the anchor point in the directory to jump to the corresponding article content
  • Share url with anchor hash value to reader

Screenshots

Screenshots

Demo online

Instructions

This UI component needs to be used in conjunction with your article content. When using this component, you must ensure that your article under the same page content.

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}
/>

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 displacement relative to the top of the window (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.

markdown-navbar's People

Contributors

parksben avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.