This documentation website is built using Docusaurus.
If you aren't comfortable using GitHub to make changes, please contact RevenueCat Support or open an Issue with your requested change here.
Edit raw .md and .mdx that are stored in /docs. Docs that don't require code snippets or other custom components (/src/components) can use standard Markdown (.md).
After making changes, open a pull request (PR). Opening a PR will automatically build and deploy the documentation to the dev environment.
After the changes have been reviewed, and all conversations resolved, the PR can be merged. After merge, it's automatically deployed to production.
Pages are organized into categories within /docs. Add a page to one of these subfolders to make it available to use in a sidebar.
If a page uses invalid markdown, or unsupported syntax (readme-flavored, etc.) the project will fail to build. Only add files that are valid markdown to the docs folder. If docusaurus fails to build, it's likely an invalid markdown file was added to this folder.
There's a custom tabbed code block component called RCCodeBlock, imported globally to all .mdx files, that renders code snippets. Use raw-loader to pass the content to the component.
Pages must be .mdx.
Pass a set of values for each tab, reading each code file using raw-loader relative to the @site root path:
import content from "!!raw-loader!@site/code_blocks/welcome/getting_started.swift";
<RCCodeBlock
tabs={[
{
type: RCCodeBlock.languages.swift,
content: content,
title: "Getting Started", //optional
},
]}
/>;Supported languages in RCCodeBlock.languages.
The YouTubeEmbed component is imported globally to .mdx files.
<YouTubeEmbed videoId=<videoId> title=<title> />Each grouping of docs is called a 'sidebar' and is defined in sidebars.js. A sidebar is a combination of categories and pages in a tree structure, and requires each category, subcategory, and page to be defined manually.
There are four types of sidebar items:
- Category (top-level, non-clickable)
- Subcategory (document w/ sub-documents; only 1 level of nested supported)
- Page (i.e., document)
- Link (link to a document in a different Category)
const exampleCategory = Category({
emoji: "🙈",
label: "Example Category",
slug: "example",
itemsPathPrefix: "example/", // the path prefix to apply to the items in this category
items: [
SubCategory({
label: "Welcome RevenueCat",
slug: "welcome", // refers to the doc at: 'docs/' + 'example/' (parent path prefix) + 'welcome' (page slug)
itemsPathPrefix: "welcome/",
items: [
Page({ slug: "first-sub-page" }), // /docs/ + example/ + welcome/ + first-sub-page
Page({ slug: "second-sub-page" }),
],
}),
Page({ slug: "stand-alone-page" }), // /docs/ example/ stand-alone-page
Link({
label: "Linked Page",
slug: "/path/to/linked-page",
}),
],
});The default sidebar is rendered at the bottom of sidebars.js.
$ yarn
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.