Skip to main content

@britecharts/docs

Documentation package to create the documentation site for Britecharts, built using Docusaurus 2.

Usage​

@britecharts/docs will extract the updated docs from the other packages when running yarn start.

You can see here the production site deployed.

Installation​

To install the dependencies, just run:

$ yarn

Local Development​

To start developing this documentation site, run:

$ yarn start

This command does several things:

  • Copies over the Readme from the root package
  • Generates the API from the @britecharts/core chart comments
  • Starts a local development server and opens up a browser window

Changes in the markdown files of this package and configuration are reflected live without having to restart the server. However, to update the docs with the latest comments from the packages or the readme, you will need to re-run yarn start.

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.