From f9d10ddeab138e78bdbe309166d2d852c4f52143 Mon Sep 17 00:00:00 2001 From: hanyujie2002 <84226578+hanyujie2002@users.noreply.github.com> Date: Sat, 21 Sep 2024 12:06:19 +0800 Subject: [PATCH] docs: Added two examples --- README.md | 115 +++++++++++++++++++++++++++++++++++++++++++++------ example.png | Bin 0 -> 47227 bytes example1.png | Bin 0 -> 46572 bytes image.png | Bin 95906 -> 0 bytes 4 files changed, 102 insertions(+), 13 deletions(-) create mode 100644 example.png create mode 100644 example1.png delete mode 100644 image.png diff --git a/README.md b/README.md index 0481091..df62bc5 100644 --- a/README.md +++ b/README.md @@ -11,30 +11,28 @@ A Nuxt module for table of contents (TOC) component in your Nuxt Content projects. -
- example -
- [✨  Release Notes](https://github.com/hanyujie2002/nuxt-toc/releases) -## Features +## Features ✨ -- 📑  Automatically generates a TOC from your content -- 🔗  Links to sections within your content -- 🎨  Customizable styles and active state handling +- 🎨 **Highly Customizable**: Tailor it to fit your unique needs. +- 🔍 **Active TOC Highlighting**: Easily see which section you're in. +- 📦 **Out of the Box**: Ready to use with minimal setup. +- 🔗 **Section Links**: Navigate seamlessly within your content. -## Quick Setup +## Quick Start 🔧 -Install the module to your Nuxt application with one command: +1. Install the module to your Nuxt application with one command: ```bash npx nuxi module add nuxt-toc ``` -## Quick Start +2. Add `` at where TOC is needed. ```vue