Pappify Documentation Site

Complete Docusaurus documentation site for Pappify - the next-generation Lavalink client.

🌐 Live Site: https://pappify.js.org

📚 What's Included

Documentation Pages

• Getting Started - Installation and quick start guide
• Playing Music - Complete music playback guide
• Audio Effects - 25+ effects and filters documentation
• Text-to-Speech - TTS in 28 languages
• Plugins - Built-in and custom plugin system
• Examples - Real-world code examples
• FAQ - Common questions and troubleshooting
• API Reference - Complete API documentation
  • Pappify Class
  • Player Class
  • Queue Class

Features

• Fully configured Docusaurus site
• Custom branding and homepage
• Custom SVG icons (no emojis)
• Responsive design
• Dark/light mode support
• Search functionality
• GitHub Actions auto-deployment
• Custom domain setup (pappify.js.org)
• SEO optimized

🚀 Quick Start

Development

cd docs
npm install
npm start

Visit http://localhost:3000

Build

cd docs
npm run build

Test Production Build

cd docs
npm run serve

🎨 Branding

Custom Logo & Icons

• JavaScript-themed logo with yellow background (#F7DF1E)
• Music note integration showing audio focus
• Custom favicon for browser tabs
• Social media card for sharing (1200x630)
• Custom SVG icons throughout the site

All Docusaurus default branding has been replaced with Pappify custom assets.

See BRANDING.md for details.

📦 Project Structure

docs/
├── docs/                    # Documentation markdown files
│   ├── intro.md            # Getting started
│   ├── playing-music.md    # Music playback
│   ├── audio-effects.md    # Effects guide
│   ├── tts.md              # Text-to-speech
│   ├── plugins.md          # Plugin system
│   ├── examples.md         # Code examples
│   ├── faq.md              # FAQ
│   └── api/                # API reference
│       ├── pappify.md
│       ├── player.md
│       └── queue.md
├── src/
│   ├── components/         # React components
│   ├── css/                # Custom styles
│   └── pages/              # Custom pages
├── static/
│   └── CNAME              # Custom domain
├── .github/
│   └── workflows/
│       └── deploy.yml     # Auto-deployment
├── docusaurus.config.ts   # Site configuration
├── sidebars.ts            # Navigation
└── package.json

🌐 Deployment

Automatic Deployment (GitHub Actions)

1. Push to main branch
2. GitHub Actions builds and deploys automatically
3. Site updates at https://pappify.js.org

Manual Deployment

cd docs
GIT_USER=<username> npm run deploy

🔧 Configuration

GitHub Pages Setup

1. Go to repository Settings → Pages
2. Source: GitHub Actions
3. Wait for deployment to complete

Custom Domain (pappify.js.org)

1. Fork https://github.com/js-org/js.org
2. Edit cnames_active.js:

   "pappify": "teampappify.github.io/pappify"

3. Create Pull Request
4. Wait for approval (24-48 hours)

📝 Updating Documentation

1. Edit markdown files in docs/docs/
2. Commit and push to main
3. GitHub Actions deploys automatically
4. Changes live in minutes

🎨 Customization

Update Site Config

Edit docs/docusaurus.config.ts

Update Navigation

Edit docs/sidebars.ts

Update Homepage

Edit docs/src/pages/index.tsx

Update Features

Edit docs/src/components/HomepageFeatures/index.tsx

📖 Documentation

• Setup Guide - Detailed setup instructions
• Deployment Guide - Deployment instructions
• Docusaurus Docs - Official documentation

✅ Build Status

Build successful! ✨

npm run build
# [SUCCESS] Generated static files in "build".

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Test locally: npm start
5. Build: npm run build
6. Submit a pull request

📄 License

MIT

---

Ready to deploy! Follow the Setup Guide to get your site live at pappify.js.org 🚀