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.
These guidelines help keep our docs easy to navigate and consistent, as we scale.
- 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.
- For consistency in writing style and tone, refer to the principles here: https://www.notion.so/trevorio/Documentation-Principles-19a726382bcf8008a1eed5ca537b086a?pvs=4
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 localhost:3000.
Run pnpm build to build the app
Run pnpm run start to preview the built app
Sometimes, the left sidebar is cached, causing strange behaviour when deploying.
When deploying:
- Go to Vercel.
- You'll see your branch.
- Click three dots.
- Select latest deployment.
- In the top right, click the three dots.
- Click Redeploy.
- Make sure 'use existing build cache' is unticked.
- Resize to max 1250px width for videos and images.
To resize videos:
- Convert file to .mp4: https://www.freefileconvert.com/
- Resize it: https://ezgif.com/resize-video/ezgif-6-478b77626d11.mp4
To resize images
We have set this environment variable in the Vercel platform:
VERCEL_FORCE_NO_BUILD_CACHE to true
This project is licensed under the MIT License.