Beacon is a modern, open-source documentation platform built with Astro, React, and Tailwind CSS. It provides a fast, searchable, and customizable solution for creating beautiful documentation websites.
- ⚡️ Lightning Fast: Built on Astro for optimal performance and static site generation
- 🔍 Full-Text Search: Integrated search functionality powered by Fuse.js
- 🎨 Modern Design: Beautiful UI components built with Tailwind CSS
- 📱 Responsive: Fully responsive design with mobile-friendly navigation
- 🌙 Dark Mode Ready: Support for both light and dark themes
- ⚙️ MDX Support: Write documentation using MDX for enhanced functionality
- Clone the repository:
git clone https://github.com/yourusername/beacon.git
cd beacon- Install dependencies:
npm install- Start the development server:
npm run dev- Visit
http://localhost:4321to see your documentation site.
- Astro - Static Site Generator
- React - UI Components
- Tailwind CSS - Styling
- MDX - Enhanced Markdown
- Fuse.js - Search Functionality
| Command | Action |
|---|---|
npm install |
Install dependencies |
npm run dev |
Start development server at localhost:4321 |
npm run build |
Build production site to ./dist/ |
npm run preview |
Preview production build locally |
Built-in search capabilities allow users to quickly find documentation content using Fuse.js for fuzzy searching.
Mobile-friendly navigation with a collapsible sidebar and smooth transitions.
Write documentation using MDX to combine Markdown with React components.
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
- Built with Astro
- Styled with Tailwind CSS
- Search powered by Fuse.js