BooGi

screenshot of BooGi
gatsby
react
scss

BooGi

Generate GitBook-like modern docs/tutorial websites using Gatsby

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
gatsby
Gatsby

GatsbyJS is a free and open-source static site generator based on React. It uses a modern development stack including Webpack, GraphQL, and modern JavaScript and CSS frameworks. It also provides a rich set of plugins, starters, and themes.

react
React

React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components

scss
SCSS

SCSS is a preprocessor scripting language that extends the capabilities of CSS by adding features such as variables, nesting, and mixins. It allows developers to write more efficient and maintainable CSS code, and helps to streamline the development process by reducing repetition and increasing reusability.

eslint
Eslint

ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.

mdx
MDX

MDX is a format that allows developers to write JSX within Markdown documents, combining the power of React with the simplicity of Markdown. This allows for the creation of dynamic and interactive content that can be easily shared and consumed across different platforms and devices.