Welcome to the PowerSync documentation repository! Our docs are powered by Mintlify.
-
Fork and clone your repository:
- On GitHub, click "Fork" at the top right of this repository to create your own copy.
- Then clone your fork:
git clone https://github.com/YOUR-USERNAME/powersync-docs.git cd powersync-docs -
Install Mintlify CLI:
npx mintlify install -
Start the local docs server:
- Run the following command at the root of the repo (where docs.json is):
npx mintlify dev- If you see the error
✖ Must be run in a directory where a mint.json file exists., update Mintlify:
npx mintlify@latest dev
We welcome contributions! Please see CONTRIBUTING.md for details.
All changes merged to the main branch are automatically published to https://docs.powersync.com.
- Navigation and other global settings are defined in
docs.json. Learn more in Mintlify's docs. - If you move or rename a page, add a redirect using the
redirectsproperty to ensure existing links continue to work.
Regularly check for broken links by running:
npx mintlify broken-links
To whitelist terms so Mintlify's Vale integration does not flag them as misspelled:
- Add terms (one per line, case-insensitive) to
.github/vale/config/vocabularies/PowerSync/accept.txt. - To blacklist terms, create a
reject.txtfile in the same folder. - For more info, see Mintlify's docs and Vale's docs.
FontAwesome icons are supported: https://fontawesome.com/search
We use the following icons for supported backend databases and SDKs:
- Postgres:
icon="elephant" - MongoDB:
icon="leaf" - MySQL:
icon="dolphin" - Flutter:
icon="flutter" - React Native:
icon="react" - Web:
icon="js" - Kotlin:
icon="k" - Swift:
icon="swift" - Node.js:
icon="node-js" - .NET:
icon="microsoft"
- Mintlify dev isn't running: Run
npx mintlify installto re-install dependencies. - Page loads as a 404: Make sure you are running in a folder with
docs.json.