Skip to content

gaodeng/botgem-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BotGem Desktop Icon

BotGem Documentation

This repository contains the official documentation for BotGem.

Overview

BotGem is a versatile application that provides AI-powered tools to enhance productivity and creativity. This documentation site is built with VitePress and serves as a comprehensive resource for users to learn about BotGem's features, integrations, and capabilities.

The official documentation is deployed and accessible at docs.botgem.com.

Getting Started

Prerequisites

  • Node.js (v18 or higher)
  • npm or yarn

Installation

  1. Clone this repository
  2. Install dependencies:
    npm install

Local Development

To start the development server:

npm run docs:dev

The site will be available at http://localhost:5173

Build

To build the documentation for production:

npm run docs:build

Preview Production Build

To preview the production build locally:

npm run docs:preview

Deployment

The documentation is officially deployed at docs.botgem.com. After building the site with npm run docs:build, the generated static files in the docs/.vitepress/dist directory can be deployed to your hosting platform of choice.

Documentation Structure

  • Get Started: Introduction and quickstart guides
  • Guides: Detailed documentation on specific features
    • Service Providers
    • Ollama Integration
    • AI-Fusion
  • Partner With Us: Information for potential partners
  • FAQ: Frequently asked questions

Multilingual Support

The documentation is available in:

  • English (default)
  • Chinese (zh)

Contributing

Contributions to improve the documentation are welcome. Please feel free to submit a pull request.

Contact

For more information, visit BotGem's website or reach out through the contact page.

About

This repository contains the official documentation for BotGem

Resources

Stars

Watchers

Forks