BooGi

Overview

BooGi is a documentation site engine that aims to provide teams with a powerful tool for efficiently sharing knowledge. Inspired by Gitbook, BooGi offers custom styling and components, allowing users to create beautiful documentation quickly. It follows the “docs-as-code” principles, treating documentation as code and providing features such as Markdown/MDX support, rich content capabilities, search integration, PWA functionality, SEO friendliness, and easy deployment options.

Features

• Write using Markdown/MDX
• Customizable page appearance to match branding and needs
• GitBook-like style theme with light and dark mode options
• Responsive design with mobile and tablet support
• Rich-content features including text formatting, graphs and diagrams, quotes, columnar layout, emojis, live code editor, and syntax highlighting
• Draft page support
• Integration with Algolia for search functionality
• Local search option for browsing without Algolia integration
• Progressive Web App (PWA) capability for offline access
• Integration with Google Analytics
• Full-screen mode for improved reading experience
• Search Engine Optimization (SEO) friendliness
• RSS feed functionality
• Easy content editing on GitLab, GitHub, or Bitbucket
• Custom CLI tool for initializing and developing BooGi apps
• Easy deployment on the platform of choice

Installation

Using boogi-cli (recommended):

1. Install boogi-cli by running the following command: npm install -g boogi-cli
2. Initialize BooGi project in the current directory by running: boogi init
3. Follow the configuration wizard to set up the project.
4. Run the app in development mode with live reload using: boogi start
5. Build the app package ready for deployment by running: boogi build

Using gatsby-cli:

1. Install gatsby-cli by running the following command: npm install -g gatsby-cli
2. Run the following commands to get started:
   • gatsby new my-boogi-app https://github.com/hasura/gatsby-gitbook-starter
   • cd my-boogi-app
   • gatsby develop
3. Visit http://localhost:8000/ to view the app.

Summary

BooGi is a documentation site engine that allows teams to efficiently share knowledge by providing a customizable and feature-rich platform for creating documentation. With its Markdown/MDX support, GitBook-like styling, responsive design, rich-content features, search integration, PWA capability, and easy deployment options, BooGi offers an excellent solution for building beautiful and functional documentation sites.