docs: Add props info in readme

hanyujie2002 · Sep 20, 2024 · 364ed30 · 364ed30
1 parent aa2b230
commit 364ed30
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -43,6 +43,15 @@ npx nuxi module add nuxt-toc
 </template>
 ```
 
+## Props
+
+| **Prop**           | **Type** | **Default** | **Description**                                                                                     |
+|--------------------|----------|-------------|-----------------------------------------------------------------------------------------------------|
+| `path`             | String   | `''`        | The path to the content for which the TOC is generated. **If not set, `nuxt-toc` will default to using the current URI as the path**.                                    |
+| `isSubListShown`   | Boolean  | `true`      | Determines whether the sublist within the TOC is shown.                                             |
+| `title`            | String   | `'Table of Contents'` | The title of the TOC.                                                                               |
+| `isSublistNested`  | Boolean  | `true`      | Determines whether the sublist within the TOC is nested.                                            |
+
 ## Styling
 
 | **ID/Class**                | **Type** | **Description**                                                                                     |