You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
layui/docs
morning-star 96f0621ff2
新增 laypage countText 选项 (#1444)
12 months ago
..
.layui 优化 docs 子文档的引用路径 2 years ago
anim 优化 Docs 内容,添加引入 `layui.js` 的位置注释 2 years ago
auxiliar Add docs 2 years ago
badge Add docs 2 years ago
button 更新 button 按钮主题示例 1 year ago
carousel 修正 carousel 文档中的 `autoplay` 属性可选值 1 year ago
class 更新 docs 中的引入资源 1 year ago
code 完善 code 文档中属性说明 1 year ago
color color 文档优化 2 years ago
colorpicker 更正 colorpicker 文档说明 1 year ago
dropdown 更新 docs 相关静态路径 1 year ago
fixbar 更新 docs 中的引入资源 1 year ago
flow 优化 docs 子文档的引用路径 2 years ago
form 修复部分文档和模块注释中的错别字 1 year ago
icon 优化 icon 文档中复制功能细节 1 year ago
laydate 优化 laydate 文档中快捷选项示例代码 1 year ago
layer 优化 `layer.closeLast()` 稳定细节 1 year ago
layout 更新 docs 中的引入资源 1 year ago
laypage 新增 laypage countText 选项 (#1444) 12 months ago
laytpl 添加 latpl 应用安全提示注释 1 year ago
menu 更新 docs 中的引入资源 1 year ago
nav 更新 docs 中的引入资源 1 year ago
panel 优化 Docs 内容,添加引入 `layui.js` 的位置注释 2 years ago
progress 优化 Docs 内容,添加引入 `layui.js` 的位置注释 2 years ago
rate 优化 docs 子文档的引用路径 2 years ago
slider 优化 docs 子文档的引用路径 2 years ago
tab 完善 tab 文档中的示例的资源引入 1 year ago
table 更新 table height 选项文档,添加函数类型描述 1 year ago
timeline Add docs 2 years ago
transfer 修复部分文档和模块注释中的错别字 1 year ago
tree 更新 `customName` 属性文档介绍 1 year ago
treeTable 增加 treeTable 对 ie8 的兼容方案说明 1 year ago
upload 优化 `layer` 和 `upload` 文档 1 year ago
util 优化 util 模块文档 (#1435) 1 year ago
README.md 更新 docs 入口链接 1 year ago
base.md 修正 `layui.config()` 的示例代码 1 year ago
favicon.ico 新增 Layui 新 LOGO 2 years ago
index.md 更新 docs 中的引入资源 1 year ago
modules.md 修正 docs 模块说明的错别字 1 year ago
versions.md 更正 2.9.0 更新日志错别字 1 year ago

README.md

Docs

文档预览

目录规范

文档的目录与文件命名,需与组件的命名对应。子目录可自由发挥,但一般可参考以下规则:

  • index.md 组件主文件
  • detail/ 组件详情文件。一般在主文件内容过大时,可将内容碎片放置在该目录中,主文件只需引用即可。
  • examples/ 组件示例文件。

当创建新的组件文档时,可复制 .layui/ 目录中放置好的文档模板,并填充对应的内容。

书写规范

文档采用 HTML+Markdown+laytpl 混合编写。 其中:

  • HTML 标签与 Markdown 混用时,必须换两行隔开
  • laytpl 标签语法可直接遵循 Layui 中的 laytpl 组件规则
  • 若需开启文档的右侧目录,可在对应锚点元素上添加 lay-toc="{}" 属性即可,具体可参考其他组件中的内容