https://github.com/AirCodeLabs/documate

Embed AI chat dialog into your doc site to answer user questions based on your own content.
https://github.com/AirCodeLabs/documate

ai chatgpt docsify documentation docusaurus serverless static-site-generator vitepress

Last synced: 3 months ago
JSON representation

Embed AI chat dialog into your doc site to answer user questions based on your own content.

• Host: GitHub
• URL: https://github.com/AirCodeLabs/documate
• Owner: aircodelabs
• License: mpl-2.0
• Created: 2023-08-29T05:43:14.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-01T06:18:11.000Z (about 1 year ago)
• Last Synced: 2024-07-31T08:19:18.448Z (3 months ago)
• Topics: ai, chatgpt, docsify, documentation, docusaurus, serverless, static-site-generator, vitepress
• Language: TypeScript
• Homepage: https://documate.site
• Size: 11.3 MB
• Stars: 783
• Watchers: 8
• Forks: 43
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-chatgpt - AirCodeLabs/documate - Documate is an open-source tool that seamlessly integrates an AI chat dialog into your documentation site, allowing users to ask questions and receive real-time answers based on your content. (SDK, Libraries, Frameworks / JavaScript/Typescript)

README

        


  

    

      

    

    
Documate


  

  


    Website

     · 

    Discord

     · 

    Discussions 

  


Documate is an open-source tool designed to seamlessly embed AI chat dialog into your documentation site. It uses your content to generate real-time answers to user questions, effectively acting as a "ChatGPT" for your platform.

- **Hassle-free integration** - Easily integrate with VitePress, Docusaurus, Docsify, and any other doc sites, no AI or LLM knowledge required.

- **Fully controllable** - You own the code, you own your data, you choose which content to index.

- **Fully customizable** - Come with a finely-tuned UI that's fully customizable to cater to your specific needs.

## Getting Started

Visit [https://documate.site](https://documate.site) to get started.

This site also serves as a demo showcasing what Documate can achieve for you.

## Examples

Browse the [examples directory](./examples/) for code samples. Each example can be used as a headless template to kickstart a project featuring Documate.

## Community

For help, voice ideas, or discussion about best practices:

[Discuss Documate on GitHub Discussions](https://github.com/aircodelabs/documate/discussions)

To chat with other community members:

[Join the Documate Discord](https://discord.gg/YhypQrZBu5)

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.

## Authors

- Adcent Lei ([@adcentlei](https://twitter.com/adcentlei))

- Kevin Wu ([@0xinhua](https://twitter.com/0xinhua))

- Akira Wu ([@akira_cn](https://twitter.com/akira_cn))

## License

[Mozilla Public License 2.0](./LICENSE)