platform/docs
2023-03-26 14:25:04 -05:00
..
docs Adds some more detail to authentication document 2023-03-26 14:25:04 -05:00
src Improve provider unsubscribes and lookups 2023-03-22 17:10:46 -05:00
static Improve provider unsubscribes and lookups 2023-03-22 17:10:46 -05:00
.gitignore Adds docs folder with Docusaurus 2023-02-25 09:17:05 -06:00
babel.config.js Adds docs folder with Docusaurus 2023-02-25 09:17:05 -06:00
docusaurus.config.js Improve provider unsubscribes and lookups 2023-03-22 17:10:46 -05:00
package-lock.json Adds docs folder with Docusaurus 2023-02-25 09:17:05 -06:00
package.json Documentation tweaks 2023-02-25 09:17:05 -06:00
README.md Adds docs folder with Docusaurus 2023-02-25 09:17:05 -06:00
sidebars.js Adds docs folder with Docusaurus 2023-02-25 09:17:05 -06:00
tsconfig.json Adds docs folder with Docusaurus 2023-02-25 09:17:05 -06:00

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.