@cmsgov/design-system-docs

Design system's documentation website

Usage no npm install needed!

<script type="module">
  import cmsgovDesignSystemDocs from 'https://cdn.skypack.dev/@cmsgov/design-system-docs';
</script>

README

This package contains default content and assets for CMS design system documentation site. It contains the following:

  • Markdown files containing site content
  • Example HTML and React files
  • Documentation site specific components, styles and images

Usage

This package is used to build a documentation site for CMS core and child design systems. Unless you are a CMS design system maintainer, this probably won't be relevant to you. See the design-system-scripts package README.md for more information on how to build a documentation site using this package.

Bugs and contributions

Please submit an issue on GitHub for any bugs or feature requests.

To learn how documentation is generated, view the "Writing documentation" page.