https://github.com/studio24/design-system

Simple documentation-first tool to build a static design system
https://github.com/studio24/design-system

design-system docs php twig

Last synced: 3 days ago
JSON representation

Simple documentation-first tool to build a static design system

• Host: GitHub
• URL: https://github.com/studio24/design-system
• Owner: studio24
• License: mit
• Created: 2020-05-24T09:58:23.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-10T17:35:12.000Z (2 months ago)
• Last Synced: 2024-10-01T23:46:33.909Z (about 2 months ago)
• Topics: design-system, docs, php, twig
• Language: PHP
• Homepage:
• Size: 481 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Design system

Simple documentation-first tool to build a static design system website based on Markdown documentation files and Twig templates.

Key features:

* Documentation-first approach, builds design system website based on Markdown docs and [Twig](https://twig.symfony.com/) templates

* Manually control primary navigation

* Automatically generates sibling navigation

* Include code examples and full-page example templates via custom tags (displays embedded code and HTML source code)

* Include sample data for code examples and templates

* Generate colour swatches in documentation

* Extensible via custom tags

* Automatically create ZIP file of frontend assets

## Requirements

* PHP 7.4+

* [Composer](https://getcomposer.org/)

## Installation

Load the library for local development only:

```bash

composer require --dev studio24/design-system

```

If you already have this in your project then just run `composer install` to download the files. To update your copy of

the the design system library files run `composer update`

To build the design system website files:

```

./vendor/bin/design-system

```

To see what files the design system is outputting pass the `-v` verbose option.

```

./vendor/bin/design-system -v 

```

You can then view the design system website via:

```bash

php -S localhost:8000 -t _dist

```

## Documentation

See [docs](docs/README.md) for further details.

See [contributing](docs/contributing.md) for making changes to this repo.

## License

[MIT License](LICENSE) (MIT) Copyright (c) 2020 Studio 24 Ltd (www.studio24.net)

## Credits

Developed by [Simon R Jones](https://github.com/simonrjones/), HTML/CSS design system layout by Nicola Saunders.

Inspired by [GOVUK Design System](https://design-system.service.gov.uk/) and [Drizzle](https://github.com/cloudfour/drizzle).