ac59b8c72e
this will throw an error if docusaurus find any broken links Signed-off-by: jffarge <jf@dagger.io> |
||
|---|---|---|
| .. | ||
| cypress | ||
| plugins/docusaurus-plugin-hotjar | ||
| src | ||
| static | ||
| .gitignore | ||
| .prettierrc | ||
| babel.config.js | ||
| cypress.json | ||
| docsearch.config.json | ||
| docusaurus.config.js | ||
| env.example | ||
| netlify.toml | ||
| package.json | ||
| README.md | ||
| rebuild_algolia_docs_search_index.sh | ||
| sidebars.js | ||
| yarn.lock | ||
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
yarn install
Local Development
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.
Build
yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
GIT_USER=<Your GitHub username> USE_SSH=true 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.