From 1a4306cb886112fc14868adad4f272a746d7bf53 Mon Sep 17 00:00:00 2001 From: Travis Fischer Date: Fri, 22 Jan 2021 15:33:57 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=90=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- readme.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index a9b43d6..6e0f3c4 100644 --- a/readme.md +++ b/readme.md @@ -145,7 +145,9 @@ Note that you shouldn't have to do anything extra to enable this feature as long Smooth ToC Scrollspy

-By default, every article page will have a table of contents displayed as an `aside` on desktop. It uses scrollspy logic to automatically update the current section as the user scrolls through your document, and makes it really easy to jump between different sections. +By default, every article page will have a table of contents displayed as an `aside` on desktop. It uses **scrollspy** logic to automatically update the current section as the user scrolls through your document, and makes it really easy to jump between different sections. + +If a page has less than `minTableOfContentsItems` (default 3), the table of contents will be hidden. It is also hidden on the index page and if the browser window is too small. This table of contents uses the same logic that Notion uses for its built-in Table of Contents block (see [getPageTableOfContents](https://github.com/NotionX/react-notion-x/blob/master/packages/notion-utils/src/get-page-table-of-contents.ts) for the underlying logic and associated unit tests).