跳转到主要内容

一个Django模块,允许为您的项目构建模式库。

项目描述

django-pattern-library

PyPI PyPI downloads Build status

为Django模板的UI模式库。试试我们的在线演示

Screenshot of the pattern library UI, with navigation, pattern rendering, and configuration

功能

此包自动维护Django项目的UI模式库或风格指南,并允许开发者在不创建Django视图和模型的情况下实验Django模板。

  • 通过创建Django模板文件来创建可重用模式,就像平常一样。
  • 所有模式都会自动显示在模式库的界面上。
  • 将数据定义为YAML文件,以便模板在相关的Django上下文中进行渲染。
  • 根据需要覆盖Django模板标签来模拟模板的依赖关系。
  • 使用Markdown记录您的模式。

为什么你需要这个

模式库将使你的工作流程变得更好

  • 它们有助于分离关注点,无论是在代码中还是在开发团队成员之间。
  • 如果需要,它们使在创建模型和视图之前进行UI开发成为可能。
  • 它们鼓励代码重用——定义独立的UI组件,可以在应用程序之间重用或移植到其他项目。
  • 这使得测试UI组件变得非常简单——无需弄清楚它们在网站或应用程序中的使用位置。

通过观看我们的演示了解更多信息 - 可重用UI组件:从React到Wagtail的旅程

在线演示

模式库依赖于Django进行渲染 - 但也支持在需要时导出为静态网站。试试我们的在线演示

文档

文档可在torchbox.github.io/django-pattern-library找到,源文件位于docs目录中。

贡献

你喜欢这里的内容吗?有什么缺失的吗?我们欢迎所有支持,无论是错误报告、功能请求、代码、设计、评论、测试、文档等等。请查看我们的贡献指南

如果您想在您的计算机上设置项目,贡献指南还包含了所有设置命令。

夜间构建

为了在发布之前试用最新功能,我们还从main分支的每个提交中创建构建。请注意,我们对这些预发布版本的质量不提供任何保证,并且预发布版本在每次构建时都会被覆盖,因此不应依赖于可重复构建。 下载最新的django_pattern_library-0.0.0.dev0-py3-none-any.whl

鸣谢

查看完整的贡献者列表。采用BSD许可证。

项目标志来自FxEmoji。使用MkDocs构建文档网站,并托管在GitHub Pages上。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪一个,请了解更多关于 安装包 的信息。

源分发

django_pattern_library-1.2.0.tar.gz (30.4 kB 查看哈希值)

上传时间

构建分发

django_pattern_library-1.2.0-py3-none-any.whl (33.1 kB 查看哈希值)

上传时间 Python 3

支持者