c87294b5b2
This commit contains: * fix the build script, so that only versions are added that have a `docusaurus.config.js` * some refactoring so that the build script will work well with github pages * add configuration to the `docusaurus.config.js` to display a dropdown menu to select a version The behavior for the versioning is now so that 2.6 is both the 'latest' version as well as the 'next' version. As soon as 2.7 will be built that will be displayed as the 'next' version. closes #16671 |
||
|---|---|---|
| .. | ||
| backup | ||
| docs | ||
| src | ||
| static | ||
| vagrant | ||
| .gitignore | ||
| babel.config.js | ||
| build.sh | ||
| docusaurus.config.js | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| tsconfig.json | ||
| Vagrantfile | ||
| yarn.lock | ||
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
$ yarn
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
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.