Skip to content

Files

Latest commit

11aeaa5 · May 27, 2025

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Jan 27, 2025
May 22, 2025
May 22, 2025
Jan 15, 2025
Feb 13, 2025
Jan 27, 2025
Oct 4, 2023
May 6, 2025
May 15, 2025
May 27, 2025
Jan 5, 2024
Jan 27, 2025

CMS Design System Documentation Site

The Gatsby-powered documentation site for the CMS family of design systems.

Development

Scripts

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.

Project Structure

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 names
  • src/templates: templates for programmatically creating pages
  • static: files in this folder will be copied to the public folder untouched

Additional directories that are not Gatsby specific include:

  • src/components: these are component only used for the documentation site
  • src/styles: documentation site-specific styles
  • content: Contains markdown for site page content