Skip to content

Commit b68432a

Browse files
committed
docs: update tool proposal to recommend Docus instead of Docsify
1 parent 186878b commit b68432a

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

docs/FEATURE_PROPOSAL_ADDITIONAL_TOOLS.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -416,32 +416,39 @@ echo -e "\nChecking recommended versions..."
416416

417417
## 5. Documentation & Knowledge Sharing
418418

419-
### Docsify Integration
419+
### Docus Integration
420420

421-
**Description**: Add Docsify for easy project documentation.
421+
**Description**: Add [Docus](https://docus.dev/) for modern, Vue-based documentation with advanced features.
422422

423423
**Implementation Steps**:
424-
1. Add Docsify configuration and templates
424+
1. Add Docus configuration and templates
425425
2. Create standard documentation structure
426-
3. Add GitHub Pages integration
426+
3. Configure automated deployment through GitHub Pages or Netlify
427427

428428
**Example Structure**:
429429
```
430430
docs/
431-
├── README.md # Home page
432-
├── _sidebar.md # Sidebar navigation
433-
├── architecture/ # Architecture documentation
434-
├── development/ # Development guidelines
435-
├── api/ # API documentation
436-
├── style/ # Style guidelines
437-
└── troubleshooting/ # Common issues and solutions
431+
├── content/
432+
│ ├── 0.index.md # Home page
433+
│ ├── 1.architecture/ # Architecture documentation
434+
│ ├── 2.development/ # Development guidelines
435+
│ ├── 3.api/ # API documentation
436+
│ ├── 4.style/ # Style guidelines
437+
│ └── 5.troubleshooting/ # Common issues and solutions
438+
├── public/ # Static assets
439+
├── components/ # Custom Vue components
440+
├── app.config.ts # Docus configuration
441+
└── tokens.config.ts # Theme customization
438442
```
439443

440444
**Benefits**:
441-
- Simple, searchable documentation
442-
- Easy to maintain with Markdown
443-
- Automated publishing through GitHub Pages
444-
- Collaborative documentation process
445+
- Vue-powered documentation with superior interactivity
446+
- Vue components for complex documentation needs
447+
- Built-in dark/light mode and theme customization
448+
- Content query system for dynamic documentation
449+
- Excellent code highlighting and MDC support
450+
- Seamless deployment through Netlify or Vercel
451+
- Built on Nuxt content engine for performance
445452

446453
### Architectural Decision Records (ADRs)
447454

0 commit comments

Comments
 (0)