Overview

The Stream Chat Docusaurus CLI is a powerful command-line tool designed to simplify the process of running Docusaurus locally and showcasing SDK documentation. With a focus on ease of use, this CLI makes it easier for developers to create, build, and manage their documentation projects, all while providing necessary features to ensure an efficient workflow.

By leveraging this CLI, developers can effortlessly start their documentation sites, manage versions, and include essential environment variables—all from the command line. This tool is particularly beneficial for teams maintaining SDK documentation, as it allows for a structured and organized approach to managing markdown files and assets.

Features

• Local Site Running: Quickly run your Docusaurus site locally using the command npx stream-chat-docusaurus -s to view documentation in real time.
• Version Management: Easily version your documentation by using commands like npx stream-chat-docusaurus -nv NEW_VERSION SDK_NAME to maintain clear versioning.
• Production Build: Build your documentation for production with npx stream-chat-docusaurus -b, which compiles static files to a designated build directory.
• Directory Structure Support: Organize your documentation using a structured directory approach, allowing for clean URL paths and easy navigation through various SDK sections.
• Asset Management: Integrate local assets seamlessly by placing them in an assets folder, making it straightforward to reference images and files within your markdown documentation.
• Environment Variable Configuration: Enhance the functionality of your search features by adding Algolia environment variables into your .env file for better query support.
• MDX Compatibility: Support for MDX files with specific import requirements, enhancing the versatility of your documentation with React components.
• Config Customization: Tailor the configuration by setting up a plugin file to modify the common Docusaurus configuration to suit your specific project needs.