@@ -59,6 +59,14 @@ pnpm add -g @riligar/knowledge
5959 knowledge build
6060 ```
6161
62+ ## 🎨 What you get automatically
63+
64+ | Category | Features | Benefits |
65+ | ----------| ----------| ----------|
66+ | ** Professional Interface** | • Modern and clean design<br >• Automatic sidebar navigation<br >• Breadcrumbs and table of contents<br >• Search with Ctrl+K | • Professional appearance<br >• Easy navigation<br >• Quick content discovery<br >• Instant search functionality |
67+ | ** Advanced Features** | • Copy-to-clipboard in code blocks<br >• Functional internal links<br >• SEO optimized<br >• Full accessibility | • Developer-friendly<br >• Seamless navigation<br >• Better search rankings<br >• Inclusive for all users |
68+ | ** Mobile Experience** | • Collapsible menu<br >• Touch-friendly<br >• Fast loading<br >• Smooth scrolling | • Mobile-first design<br >• Intuitive interactions<br >• Optimal performance<br >• Enhanced UX |
69+
6270## 🚀 How to Use (3 Steps)
6371
6472### 1. ** Structure your files**
@@ -87,7 +95,7 @@ Welcome! This is a simple example.
8795## Links
8896
8997- [ Installation] ( ./docs/installation.md )
90- - [ API] ( ./docs /reference.md )
98+ - [ API] ( ./api /reference.md )
9199```
92100
93101### 3. ** Generate documentation**
@@ -99,14 +107,6 @@ knowledge build
99107knowledge serve
100108```
101109
102- ## 🎨 What you get automatically
103-
104- | Category | Features | Benefits |
105- | ----------| ----------| ----------|
106- | ** Professional Interface** | • Modern and clean design<br >• Automatic sidebar navigation<br >• Breadcrumbs and table of contents<br >• Search with Ctrl+K | • Professional appearance<br >• Easy navigation<br >• Quick content discovery<br >• Instant search functionality |
107- | ** Advanced Features** | • Copy-to-clipboard in code blocks<br >• Functional internal links<br >• SEO optimized<br >• Full accessibility | • Developer-friendly<br >• Seamless navigation<br >• Better search rankings<br >• Inclusive for all users |
108- | ** Mobile Experience** | • Collapsible menu<br >• Touch-friendly<br >• Fast loading<br >• Smooth scrolling | • Mobile-first design<br >• Intuitive interactions<br >• Optimal performance<br >• Enhanced UX |
109-
110110## 📋 Ideal Use Cases
111111
112112### ** 📚 Project Documentation**
0 commit comments