Welcome to the official documentation repository for Bimagic, the ultimate Git companion. This website provides comprehensive guides, tutorials, and reference material to help you master Git with ease.
Built with Docusaurus 3, this site is designed for performance, accessibility, and a great developer experience.
Check out the live documentation at: https://bimagic.vercel.app
Clone the repository and install the dependencies:
git clone https://github.com/orion-kernel/bimagic-docs.git
cd bimagic-docs
npm installStart the development server:
npm run startThis command starts a local development server and opens up a browser window at http://localhost:3000. Most changes are reflected live without having to restart the server.
To generate a static production build:
npm run buildThe static files will be generated in the build directory.
Preview your production build locally:
npm run serveThis site is configured for deployment via GitHub Pages or Vercel.
For GitHub Pages:
# Using SSH
USE_SSH=true npm run deploy
# Not using SSH
GIT_USER=<Your GitHub username> npm run deploy.
├── blog/ # Blog posts and announcements
├── docs/ # Documentation MDX files
│ ├── menu-options/ # Detailed guides for specific features
│ └── ... # Installation, Usage, Configuration, etc.
├── src/
│ ├── components/ # Custom React components
│ ├── css/ # Global CSS and styling
│ └── pages/ # Custom standalone pages (e.g., Homepage)
├── static/ # Static assets (images, logos, favicons)
├── docusaurus.config.js # Main site configuration
└── sidebars.js # Documentation sidebar layout
We welcome contributions! Whether it's fixing a typo, improving a guide, or adding new documentation:
- Fork the repository.
- Create a new branch for your feature or bugfix.
- Commit your changes with clear messages.
- Push to your branch and open a Pull Request.
- Discord: Join our Discord server
- GitHub Issues: Report bugs or suggest features
This project is licensed under the terms specified in the repository. Built with ❤️ by orion-kernel.