This is the repo for Embeddable's Docs.
It uses the Nextra site generation framework (Documentation).
It is currently deployed and managed on Vercel.
Any changes pushed to the main branch are automatically deployed to https://docs.embeddable.com.
- Please follow our style guide
- Keep nesting no more than two levels deep (e.g. Connect your data > Integrations > Cube Cloud).
- Avoid using dropdowns as pages. They can be tricky to navigate, especially on mobile.
Use git clone https://github.com/embeddable-hq/handbook.git
Alternatively, you can try one of these popular git UI tools:
Install pnpm, e.g: npm install -g pnpm
Run pnpm i to install the dependencies.
Then, run pnpm dev to start the development server and visit https://localhost:3000.
Resize images and videos to be no more than 1250px wide.
Run pnpm build to build the app
Run pnpm run start to preview the built app
For contributors with access to our Vercel deployment, please also reference the deployment readme.
This project is licensed under the MIT License.
Embeddable is a developer toolkit for building fast, interactive, customer-facing analytics directly into your product. Fully customize analytics dashboards using React.js, and seamlessly integrate them anywhere with Web Components.
Discover more about Embeddable by reading our Docs, Customer Stories, and Blog.