The Gatsby-powered documentation site for the CMS family of design systems.
The following scripts can be run from the packages/docs folder.
npm install
Installs dependencies for the doc site. Only needs to be run on first spin up of the project, or if new dependencies are installed.
npm run develop
Runs the site locally at http:localhost:8000/
Also runs the GraphiQL playground at http://localhost:800/___graphql.
npm run build
This builds a production-ready version of the site that can be deployed.
The following scripts can be run from the root directory.
npm install
Installs dependencies for all packages. Only needs to be run on first spin up of the project, or if new dependencies are installed.
npm run start:gatsby
Runs the site locally at http:localhost:8000/
Also runs the GraphiQL playground at http://localhost:800/___graphql.
npm run build:gatsby
This builds a production-ready version of the site that can be deployed.
npm run serve:gatsby
This serves the files built from npm run build:gatsby.
npm run build-storybook:gatsby
This build storybook in production mode and moves files to packages/docs to be served as a sub-route of the documentation site.
Some directories are specific to Gatsby and details can be found on this Gatsby documentation page.
These directories include
src/pages: files in this directory automatically become pages with paths based on file namessrc/templates: templates for programmatically creating pagesstatic: files in this folder will be copied to thepublicfolder untouched
Additional directories that are not Gatsby specific include:
src/components: these are component only used for the documentation sitesrc/styles: documentation site-specific stylescontent: Contains markdown for site page content