Rive Docs

🚀 Rive Docs

This is the official repository for Rive's documentation. You can access the documentation at https://rive.app/docs.

🚀 Quick Start

🔍 Prerequisites

• You need to clone the rive-docs repository.
• Set up for local development as described in Mintlify.

🛠️ Steps

1. Clone the repository:
   • Use the command git clone https://github.com/rive-app/rive-docs to clone the rive-docs repository.
2. Set up your local development environment according to the Mintlify section.
3. Update the documentation:
   • Follow the contribution guide to make your updates.
4. Preview your changes locally:
   • Run mintlify dev to see the preview of your changes.
5. Create a pull request:
   • Follow the contribution guide to create your pull request.

✨ Features

• External Contributions: We welcome any and all external contributions. For more information, see CONTRIBUTING.md.

📦 Installation

Mintlify Installation

Rive uses Mintlify for documentation. To set up your local environment for previewing changes locally, follow Mintlify's Local Development guide.

Install Mintlify CLI

Install the Mintlify CLI to preview the documentation changes locally. Use the following command to install it:

npm i -g mintlify

Run the Preview

Run the following command at the root of your documentation (where mint.json is):

mintlify dev

Troubleshooting

⚠️ Important Note

• If mintlify dev isn't running, run mintlify install to re - install dependencies.
• If the page loads as a 404, make sure you are running in a folder with mint.json (i.e., from this repository's root directory).