studio24 / design-system
一个简单的以文档为中心的工具,用于基于Markdown文档文件和Twig模板构建静态设计系统网站
dev-main
2021-12-10 12:21 UTC
Requires
- php: >7.4.0
- alchemy/zippy: ^1.0
- league/commonmark: ^2.0
- league/flysystem: ^2.2
- masterminds/html5: ^2.7
- symfony/console: ^5.0
- symfony/stopwatch: ^5.0
- twig/twig: ^3.0
Requires (Dev)
- phpunit/phpunit: ^8
- squizlabs/php_codesniffer: ^3.5
This package is auto-updated.
Last update: 2024-09-10 17:35:15 UTC
README
一个简单的以文档为中心的工具,用于基于Markdown文档文件和Twig模板构建静态设计系统网站。
关键特性
- 以文档为中心的方法,基于Markdown文档和Twig模板构建设计系统网站
- 手动控制主导航
- 自动生成同级导航
- 通过自定义标签包含代码示例和全页示例模板(显示嵌入式代码和HTML源代码)
- 为代码示例和模板包含样本数据
- 在文档中生成颜色样本
- 通过自定义标签扩展
- 自动创建前端资源的ZIP文件
要求
- PHP 7.4+
- Composer
安装
仅用于本地开发时加载库
composer require --dev studio24/design-system
如果您已经在项目中有了这个,只需运行composer install
来下载文件。要更新设计系统库文件,请运行composer update
构建设计系统网站文件
./vendor/bin/design-system
要查看设计系统输出的文件,请传递-v
详细选项。
./vendor/bin/design-system -v
然后您可以通过以下方式查看设计系统网站:
php -S localhost:8000 -t _dist
文档
有关更多信息,请参阅docs。
许可协议
MIT License (MIT) 版权所有 (c) 2020 Studio 24 Ltd (www.studio24.net)
致谢
由Simon R Jones开发,由Nicola Saunders设计HTML/CSS设计系统布局。