Install node https://nodejs.org/en/
npm installnpm startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Search is provided by Algolia. Every time a change is made to the documentation, you should run the crawler locally which will update the search indexes.
- Ensure that your changes have been pushed and deployed to
https://docs.ditto.live. The scraper runs on the live version of the website, so they need to be deployed before following the rest of these instructions. - Install and run Docker
- Get added to the Ditto Algolia account.
- Copy the
.env.examplefile.
cp algolia/.env.example algolia/.env-
Add your Algolia API Write Key in
.env -
Run the Docker script to update the search indexes
npm run search-indexesyarn 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 deployThis website is built using Docusaurus 2, a modern static website generator.
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.