Documentation site setup
Skill ulpi-io/plugin-marketplace/plugins/aj-geddes/skills/documentation-site-setup
A curated collection of 7,800+ agent skills for Claude Desktop, sourced from skills.sh
npx -y skills add ulpi-io/plugin-marketplace --skill documentation-site-setupAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its author says it does
Copied from the file, not written here
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.
SKILL.md
2.5 KB, as published. Nobody here has run it
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