design-system-template icon indicating copy to clipboard operation
design-system-template copied to clipboard

Jekyll boilerplate for creating and documenting design system principles, style guides and patterns.

Design System Template

Design System Template is Jekyll theme and a boilerplate for creating and documenting your principles, style guides and patterns for your organization's design system. It provides just enough IA and hooks to get you going. As a bonus, I've provided links to helpful resources and inspiration to help you as you create your own custom design system. It is based on Brad Frost Style Guide Guide. The original code was cleaned and reworked, which leads to more straightforward maintenance of patterns and pages. Also, we speed up site generation.

See the demo here

Screenshot of Design System

Documentation

For more information instalation and usage see wiki.

Changelog

25. 10. 2018

  • Added support for Storybook. In component-detail layout you can set link to component in Storybook. See example
  • Enable CSS and JS minification. Example of configuration is in _config.xml
  • Added robots.txt and sitemap.xml
  • Added styles for Do / Don't examples. See example

Feedback and Questions

If you have questions or issues with Style Guide Guide, please feel free to open an issue.

License

The theme is available as open source under the terms of the MIT License.