update docs

Author: tlylt

docs/.vitepress/config.ts

@@ -8,21 +8,22 @@ export default defineConfig({
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Home', link: '/' },
-      { text: 'Examples', link: '/markdown-examples' }
+      { text: 'Vue Example', link: '/vue-example' },
+      { text: 'Vitepress Example', link: '/vitepress-example' },
     ],
 
     sidebar: [
       {
         text: 'Examples',
         items: [
-          { text: 'Markdown Examples', link: '/markdown-examples' },
-          { text: 'Runtime API Examples', link: '/api-examples' }
+          { text: 'Vue Example', link: '/vue-example' },
+          { text: 'Vitepress Example', link: '/vitepress-example' },
         ]
       }
     ],
 
     socialLinks: [
-      { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
+      { icon: 'github', link: 'https://github.com/tlylt/vue-tree' }
     ]
   },
   vue: {

docs/api-examples.md

@@ -4,21 +4,19 @@ layout: home
 
 hero:
   name: "@tlylt/vue-tree"
-  text: "@tlylt/vue-tree"
-  tagline: My great project tagline
+  text: ""
+  tagline: A Simple Vue Component to Help Visualize Your Tree Structures
   actions:
     - theme: brand
-      text: Markdown Examples
-      link: /markdown-examples
+      text: Vue Example
+      link: /vue-example
     - theme: alt
-      text: API Examples
-      link: /api-examples
+      text: Vitepress Example
+      link: /vitepress-example
 
 features:
-  - title: Feature A
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
-  - title: Feature B
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
-  - title: Feature C
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+  - title: Use spaces to indicate nesting
+    details: vue-tree will convert the spaces into tokens that visualize the nesting levels
+  - title: Customize the look
+    details: Customize the look
 ---

docs/index.md

@@ -0,0 +1,71 @@
+---
+outline: deep
+---
+
+# Vitepress Example
+
+## Installation
+Install the package via npm:
+
+```bash
+npm install @tlylt/vue-tree
+```
+
+or yarn:
+
+```bash
+yarn add @tlylt/vue-tree
+```
+
+## Configuration
+
+In your `.vitepress/config.ts`:
+
+```ts
+export default defineConfig({
+  // ...
+  vue: {
+    // @vitejs/plugin-vue options
+    template: {
+      compilerOptions: {
+        whitespace: "preserve",
+      },
+    }
+  }
+})
+```
+
+## Code
+
+```vue
+<script setup>
+import { VueTree } from '@tlylt/vue-tree'
+import '@tlylt/vue-tree/style.css'
+</script>
+
+<VueTree>
+C:/course/
+  textbook/
+    index.md
+  index.md
+  reading.md
+  site.json
+</VueTree>
+```
+
+## Rendered
+
+<script setup>
+import { VueTree } from '../src/index'
+// import { VueTree } from '@tlylt/vue-tree'
+// import '@tlylt/vue-tree/style.css'
+</script>
+
+<VueTree>
+C:/course/
+  textbook/
+    index.md
+  index.md
+  reading.md
+  site.json
+</VueTree>

docs/markdown-examples.md

@@ -0,0 +1,82 @@
+# Vue Example
+
+## Installation
+Install the package via npm:
+
+```bash
+npm install @tlylt/vue-tree
+```
+
+or yarn:
+
+```bash
+yarn add @tlylt/vue-tree
+```
+
+## Configuration
+To ensure proper rendering of the tree structure, you need to configure the Vue compiler to preserve whitespace. Update your `vite.config.ts` as follows:
+
+```ts
+// https://vite.dev/config/
+export default defineConfig({
+  // ...
+  plugins: [vue(
+    {
+      template: {
+        compilerOptions: {
+          whitespace: "preserve",
+        },
+      }
+    }
+  )],
+})
+```
+
+## Code
+You can locally register the `VueTree` component in your Vue file:
+
+```vue
+<script setup lang="ts">
+import { VueTree } from '@tlylt/vue-tree'
+import '@tlylt/vue-tree/style.css'
+</script>
+
+<template>
+  <VueTree>
+  C:/course/
+    textbook/
+      index.md
+    index.md
+    reading.md
+    site.json
+  </VueTree>
+</template>
+```
+
+Alternatively, you can register the `VueTree` component globally in your `main.ts`:
+
+```ts
+import { createApp } from 'vue';
+import App from './App.vue';
+import { VueTree } from '@tlylt/vue-tree';
+import '@tlylt/vue-tree/style.css'; // Import the styles
+
+const app = createApp(App);
+app.use(VueTree);
+app.mount('#app');
+```
+
+## Rendered
+
+<script setup>
+import { VueTree } from '../src/index'
+</script>
+
+<VueTree>
+C:/course/
+  textbook/
+    index.md
+  index.md
+  reading.md
+  site.json
+</VueTree>