Welcome to the official repository for Rive's documentation, available at https://rive.app/docs.
We welcome any and all external contributions. For more information, see CONTRIBUTING.md.
- Clone the rive-docs repository.
- Set up for local development as described in Mintlify.
- Update the documentation, following the contribution guide.
- Run
mintlify devto preview your changes locally - Create your pull request, following the contribution guide.
Rive uses Mintlify for documentation. Follow Mintlify's Local Development guide to set up your local environment for previewing your changes locally.
Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command
npm i -g mintlify
Run the following command at the root of your documentation (where mint.json is)
mintlify dev
- Mintlify dev isn't running - Run
mintlify installit'll re-install dependencies. - Page loads as a 404 - Make sure you are running in a folder with
mint.json(i.e from this repository's root directory).
Display a YouTube video
import { YouTube } from '/snippets/youtube.mdx'
<YouTube id="6J3JIwgUwe0" />
- Publish the demo to the Marketplace using the support at Rive user account (credentials in 1password).
import { Marketplace } from '/snippets/marketplace.mdx'
<Marketplace
href="https://rive.app/community/files/26116-48795-animating-draw-order"
/>
- Publish the demo to the Marketplace using the support at Rive user account (credentials in 1password).
- Upload the 400x300px thumbnail to the
rive-static-content/docsS3 bucket (This is necessary until Mintlify supports hosting images that are in an array). - Add a new item in the
examplesDataarray in demos.jsx.
import { Demos } from '/snippets/demos.jsx'
// Display a single demos
<Demos examples={['dataBindingQuickStart']} />
// Display multiple demos
<Demos examples={['dataBindingQuickStart', 'cachingARiveFile']} />
// Display only content for a single runtime
<Demos examples={['dataBindingQuickStart']} runtime="apple" />
// Define the number of columns
<Demos examples={['dataBindingQuickStart']} columns={3} />
// Add a custom child component
// See demos.mdx for a real example
<Demos examples={['dataBindingQuickStart']} childrenIndex={0} >
<div>I'm a child!</div>
</Demos>