Skip to content

wadjih-bencheikh18/react-plot-docs

 
 

Repository files navigation

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.

Demos

There is a custom webpack loader to automatically process demo files. Demo files are examples of code that illustrate how to use react-plot.

To create a demo, just create a file which ends in .demo.tsx next to your md file and import it / use it from there. The demo file should have a default export with the example to render.

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.

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 65.6%
  • TypeScript 21.6%
  • CSS 12.8%