Skip to content

Documentation for Victory: A collection of composable React components for building interactive data visualizations

Notifications You must be signed in to change notification settings

benco03/victory-docs

 
 

Repository files navigation

victory documentation site

Build Status


Documentation site for victory. victory-docs is running on gatsbyjs.

Getting Started

To install and run the docs site locally:

yarn install
yarn run develop 

Then, open your favorite browser to localhost:8000. GraphiQL runs at localhost:8000/___graphql.

Ready to Deploy :shipit:

Build the site to test locally.

yarn run build

Serve the build.

yarn run serve

Then, open your favorite browser to localhost:9000 to verify everything looks correct.

If everything checks out, build the production site with the prefixed path, /open-source/victory/, so the files load at the correct URL!

yarn run build:pp

To publish to NPM run

npm version <newversion | major | minor | patch> (see Versioning notes below)

Versioning Notes

For a reliable systems of releases, victory-docs should aim for versioning along these lines:

  • Patch: Typos, missing assets, broken styles, very minor copyedits.
  • Minor: Add a new blog post, change styles.
  • Major: Rearchitect how the lander works, remove pages, or something else huge.

About

Documentation for Victory: A collection of composable React components for building interactive data visualizations

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 76.2%
  • CSS 23.8%