Emmanuel Olivi 3932f2adb6 doc: add doc about ratio.comments in Overview section 2 years ago
..
docs 3932f2adb6 doc: add doc about ratio.comments in Overview section 2 years ago
src 35053ed6e3 update logo icon and remove blog 3 years ago
static 35053ed6e3 update logo icon and remove blog 3 years ago
.gitignore 83e7f3b933 add github action to publish docs to gh-pages branch 3 years ago
README.md d034a79893 . 4 years ago
babel.config.js 21b418eace The folder docs has been modified. 4 years ago
docusaurus.config.js 91a748d61f fix gh pages root page 3 years ago
package-lock.json 35053ed6e3 update logo icon and remove blog 3 years ago
package.json 21b418eace The folder docs has been modified. 4 years ago
sidebars.js 1849699a81 files renamed 4 years ago

README.md

Website

This website is built using Docusaurus 2.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and open 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.