This website is built using Docusaurus 2, a modern static website generator.
yarn installyarn startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
yarn buildThis command generates static content into the build directory and can be served using any static contents hosting service.
GIT_USER=<Your GitHub username> USE_SSH=true yarn deployIf you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.
API docs are automatically generated from the Lightdash API and hosted on this site. They are publicly available here
The source of truth for the API docs is the OpenAPI spec which is used to generate the docs.
The update-swagger.yml GitHub Action runs on a schedule and updates the docs site with the latest API docs. You can also manually trigger a build by going to the Github actions and clicking the "Run workflow" button.