开放大学/ou-web-ui

此包已被废弃且不再维护。未建议替换包。

OU Web UI 是一套设计模式、组件和模板,旨在为学生提供一致的用户体验。

v4.0.0-alpha.6 2017-01-06 16:41 UTC

README

OU Web UI 是一套设计模式、组件和模板,以便我们能为学生提供一致的用户体验。

它是与 OU 公共网站使用的设计相同系列的工作的一部分,但更符合学生和他们的学习旅程的需求。这是框架的第五个版本(v5)。

要开始使用,请访问 http://the-open-university.github.io/ou-web-ui/

目录

快速开始

有几种快速开始选项可用

  • 下载最新版本.
  • 克隆仓库: git clone https://github.com/the-open-university/ou-web-ui.git
  • 使用 Bower 安装: (即将推出)。
  • 使用 npm 安装: (即将推出)。
  • 使用 Meteor 安装: (即将推出)。
  • 使用 Composer 安装: (即将推出)。

阅读 入门页面 了解框架内容、模板和示例等信息。

包含的内容

在下载中,您将找到以下目录和文件,它们逻辑上分组了常见的资产,并提供编译和压缩版本。您将看到如下内容

ou-web-ui/
├── css/
│   ├── ou-web-ui.css
│   ├── ou-web-ui.css.map
│   ├── ou-web-ui.min.css
│   ├── ou-web-ui.min.css.map
├── js/
│   ├── ou-web-ui.js
│   └── ou-web-ui.min.js
└── fonts/
    ├── glyphicons-halflings-regular.eot
    ├── glyphicons-halflings-regular.svg
    ├── glyphicons-halflings-regular.ttf
    ├── glyphicons-halflings-regular.woff
    └── glyphicons-halflings-regular.woff2

我们提供编译的 CSS 和 JS(ou-web-ui.*),以及编译和压缩的 CSS 和 JS(ou-web-ui.min.*)。CSS 源映射ou-web-ui.*.map)可用于与某些浏览器的开发者工具一起使用。包括来自 Glyphicons 的字体。

错误和功能请求

有错误或功能请求吗?请首先阅读 问题指南 并搜索现有和关闭的问题。如果您的問題或想法尚未解决,请 创建一个新的问题

文档

OU Web UI 的文档包含在此存储库的根目录中,使用 Jekyll 构建,并在 GitHub Pages 上公开托管,网址为 http://the-open-university.github.io/ou-web-ui。这些文档也可以在本地运行。

在本地运行文档

  1. 如有需要,使用bundle install命令安装 Jekyll 和其他 Ruby 依赖项。注意 Windows 用户:请阅读这个非官方指南,以无问题地启动 Jekyll。
  2. 在根目录 /ou-web-ui 中,在命令行运行 bundle exec jekyll serve
  3. 在浏览器中打开 https://:9001,即可。

通过阅读文档了解更多关于使用 Jekyll 的信息。

贡献

请阅读我们的贡献指南。其中包括打开问题的说明、编码标准和开发注意事项。

此外,如果你的拉取请求包含 JavaScript 补丁或功能,你必须包含相关单元测试。所有 HTML 和 CSS 应符合代码指南,由Mark Otto 维护。

编辑器首选项在编辑器配置中可用,方便在常用文本编辑器中使用。更多信息及插件下载请访问http://editorconfig.org

版本控制

为了提高发布周期的透明度并努力保持向下兼容性,OU Web UI 依据语义版本控制指南进行维护。有时我们会犯错误,但只要可能,我们都会遵守这些规则。

请查看GitHub 项目的“发布”部分以获取 OU Web UI 每个发布版本的变更日志。

版权和许可

代码和文档版权所有 2011-2016 Twitter, Inc. 代码在MIT 许可证下发布。文档在Creative Commons下发布。