This website is built using Docusaurus 2, a modern static website generator.
$ yarn
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
$ yarn build
This command generates static content into the build
directory and can be served using any static contents hosting service.
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
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.
Eraser docs website uses Algolia DocSearch service. Please see here for more information.
If the search index has any issues:
- Go to Algolia search dashboard
- Click manage index and export configuration
- Delete the index
- Import saved configuration
- Go to Algolia crawler and restart crawling manually (takes about a few minutes to crawl). This is scheduled to run every week automatically.