bonsai-rx-docs

homepage

welcome to the unofficial documentation for bonsai-rx

This website is built using Docusaurus 2, a modern documentation-oriented static website generator. Check the documentation tutorial pages if you are a new developer.

If you'd like to contribute docs but aren't interested in developing the documentation site, just use the edit buttons and submit pull requests, or submit an issue to request a new page.

Contributing

See instructions here for how to contribute.

How to build the site locally

Make sure you have the yarn Node package by installing with the package manager of your choice (brew, chocolatey, etc).

Installation

If it's your first time cloning and developing in the repo, install the requisite Node packages.

yarn install

Local Development for Testing

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. Once your changes build, submit a pull request for your changes to be reviewed.

Deployment

Once you have the site building locally and all looks good, you can manually deploy the site to GitHub Pages by running yarn deploy from the main branch. This will build the site and move the relevant files to the gh-pages branch.

Note: this is not necessary with Travis CI as this automatically triggers deployment on push and PR merge to the main branch. All you need to do is test your build locally and then commit and push or submit a pull request for review and merge.

Search

If the site moves, the algolia config file will need to be updated via pull request. Make sure to tag @shortcuts in the PR.

Resources

Nice Docusaurus Tutorial

Preparing the Docusaurus site.

Example Node gitignore.

Using Yarn with version control.