documentation-site-setup
Set up documentation websites using Docusaurus, MkDocs, VitePress, GitBook, or static site generators. Use when creating docs sites, setting up documentation portals, or building static documentation.
How do I install this agent skill?
npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill documentation-site-setupIs this agent skill safe to install?
- Gen Agent Trust Hubpass
This skill provides templates and instructions for setting up documentation websites using Docusaurus and other static site generators. It follows standard development practices and uses well-known tools.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerpass
1/1 file flagged
- ZeroLeakspass
Score: 93/100 · 2 sections analyzed
What does this agent skill do?
Documentation Site Setup
Table of Contents
Overview
Set up professional documentation websites using popular static site generators like Docusaurus, MkDocs, VitePress, and GitBook.
When to Use
- Documentation website setup
- API documentation portals
- Product documentation sites
- Technical documentation hubs
- Static site generation
- GitHub Pages deployment
- Multi-version documentation
Quick Start
- Multi-version documentation
# Create new Docusaurus site
npx create-docusaurus@latest my-docs classic
cd my-docs
# Install dependencies
npm install
# Start development server
npm start
Reference Guides
Detailed implementations in the references/ directory:
| Guide | Contents |
|---|---|
| Installation | Installation, Project Structure |
| Configuration | Configuration |
| Sidebar Configuration | Sidebar Configuration |
| Versioning | Versioning, Deployment |
| Installation | Installation, Project Structure |
| Configuration | Configuration |
| Admonitions | Admonitions, Deployment |
| Installation | Installation |
| Configuration | Configuration |
| Installation | Installation, Project Structure, Configuration, Table of Contents |
Best Practices
✅ DO
- Use consistent navigation structure
- Enable search functionality
- Add edit links to pages
- Include version selector for versioned docs
- Use syntax highlighting for code blocks
- Add dark mode support
- Optimize images and assets
- Enable analytics
- Add social media links
- Use responsive design
- Include breadcrumbs
- Add table of contents
- Test on mobile devices
❌ DON'T
- Use outdated frameworks
- Skip search functionality
- Forget mobile responsiveness
- Use slow-loading assets
- Skip accessibility features
- Ignore SEO optimization
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/aj-geddes/useful-ai-prompts/documentation-site-setup">View documentation-site-setup on skillZs</a>