Suchi

Suchi

सूची /sūcī/ - a list of things

Overview

An open source React library to create an Index (Table of Contents) for your page.

I have always enjoyed blogs or articles which have a proper index system or trable of contents to give a quick overview of the contents of the page. Besides giving a quick overview, its convenient to use the index to skip over to a section of the page quickly.

So, I came up with Suchi, an easy way to create a fully accessible Index. Suchi is just 67kB unpacked and easy to use.

Usage

Import Suchi from npm from your CLI

npm i Suchi

Usage

Import Suchi from npm from your CLI

import Suchi from "suchi" <Suchi.Root accentColor> <Suchi.Header/> <Suchi.Section> <Suchi.SectionHeader/> <Suchi.Content/> </Suchi.Section> </Suchi.Root>

Suchi automatically creates Index from the SectionHeaders and creates an Index table for both desktop and mobile views out of the box.

See the API reference at https://suchidocs.in/

Open Source

Suchi is a open source project and you can contribute to Suchi by following our Contributing Guidelines or by Reporting a Bug