Archived

This repository has been archived on 2024-04-08. You can view files and clone it, but cannot push or open issues or pull requests.

History

Helder Correia 89475e8618 docs: Add types reference Signed-off-by: Helder Correia <174525+helderco@users.noreply.github.com>		2022-04-15 11:56:43 +00:00
..
cypress	ci: enable website tests on PRs	2022-03-29 11:22:15 -07:00
plugins/docusaurus-plugin-hotjar
src	website: hardcode version banner for 0.1 docs	2022-04-13 15:58:51 +02:00
static	website: update favicon	2022-04-01 12:00:04 +02:00
.gitignore
.prettierrc
babel.config.js
cypress.json
docsearch.config.json	Rebuild Algolia search index for docs	2022-03-23 14:57:33 +00:00
docusaurus.config.js	website: Increase broken links checking	2022-04-12 13:55:50 +02:00
env.example	Rebuild Algolia search index for docs	2022-03-23 14:57:33 +00:00
netlify.toml	remove github authentication. Documentation is now public	2022-03-29 13:28:45 +02:00
package.json	build(deps-dev): bump cypress from 9.5.3 to 9.5.4 in /website	2022-04-11 19:20:16 +00:00
README.md
rebuild_algolia_docs_search_index.sh	Rebuild Algolia search index for docs	2022-03-23 14:57:33 +00:00
sidebars.js	docs: Add types reference	2022-04-15 11:56:43 +00:00
yarn.lock	build(deps-dev): bump cypress from 9.5.3 to 9.5.4 in /website	2022-04-11 19:20:16 +00:00

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

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.

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.