Skip to content

README.md

Latest commit

 

History

History
84 lines (61 loc) · 2.66 KB

README.md

File metadata and controls

84 lines (61 loc) · 2.66 KB

PowerSync Documentation

Welcome to the PowerSync documentation repository! Our docs are powered by Mintlify.

Quick Start

  1. 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
  2. Install dependencies: 
    corepack enable
pnpm install
  3. Start the local docs server: 
    pnpm dev

The install command provides you with the Mintlify CLI. For a full list of commands, refer to the docs.

Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

Publishing

All changes merged to the main branch are automatically published to https://docs.powersync.com.

Editing guidelines

Navigation & Global Settings

  • 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 redirects property to ensure existing links continue to work.

Checking for Broken Links

Regularly check for broken links by running:

pnpm check:links

Whitelisting & Blacklisting Terms (Vale)

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.txt file in the same folder.
  • For more info, see Mintlify's docs and Vale's docs.

Icons

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"
  • SQL Server: icon="server"
  • Flutter: icon="flutter"
  • React Native: icon="react"
  • Web: icon="js"
  • Kotlin: icon="android"
  • Swift: icon="swift"
  • Node.js: icon="node-js"
  • .NET: icon="microsoft"
  • Rust: icon="rust"

Useful References

Troubleshooting

  • Mintlify dev isn't running: Run pnpm install to re-install dependencies.
  • Page loads as a 404: Make sure you are running in a folder with docs.json.