Unofficial documentation site for Charmbracelet projects
This project provides documentation for the Charm Bracelet ecosystem of terminal user interface tools and libraries.
Documentation includes:
- Bubble Tea - TUI framework for Go
- Lip Gloss - Terminal styling library
- Bubbles - Reusable Bubble Tea components
- TypeScript - Static typing for JavaScript
- React 19 - Component-based UI library
- Next.js 15 - React production framework
- Fumadocs - Documentation site generator
- Bun - JavaScript runtime and package manager
- MDX - Markdown with embedded React components
git clone https://github.com/N1xev/charmbracelet-docs.git
cd charmbracelet-docs
bun install
bun devOpen http://localhost:3000 to view the documentation.
charmbracelet-docs/
├── app/ # Next.js app directory
├── content/ # MDX documentation files
│ └── docs/ # Main documentation contain all of the ecosystem documentations
├── components/ # React components
├── lib/ # Utility functions
├── public/ # Static assets
└── styles/ # Global styles
Contributions are welcome. Focus areas include:
- Documentation improvements
- Bug fixes
- Feature additions
- UI/UX enhancements
- Translation work
- Fork the repository
- Create feature branch:
git checkout -b feature/description - Commit changes:
git commit -m "type: description" - Push branch:
git push origin feature/description - Open pull request
- Write clear, technical documentation
- Include working code examples
- Verify all code snippets before submission
- Follow existing documentation patterns
This documentation aims to be comprehensive, technically accurate, and maintainable. Content should progress logically from basic concepts to advanced usage patterns.
- Complete Bubble Tea API documentation
- Interactive code examples
- Community contribution guidelines
- Multi-language support
- Search implementation
- Performance optimization
Thanks to the Charmbracelet team for building these tools and to all contributors who help maintain this documentation.