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
贤心 f428eceb6c
修正 carousel 文档中的 `autoplay` 属性可选值
1 year 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 公共类文档细节优化 2 years ago
code 优化 docs 子文档的引用路径 2 years ago
color color 文档优化 2 years ago
colorpicker 优化 docs 子文档的引用路径 2 years ago
dropdown 更新 `customName` 属性文档介绍 1 year ago
fixbar 优化 docs 子文档的引用路径 2 years ago
flow 优化 docs 子文档的引用路径 2 years ago
form 更新 form 文档介绍 1 year ago
icon 优化 icon 文档中的复制提示,并确保代码正常运行(位于 `layui.js` 之前) 2 years ago
laydate 修正 laydate 文档的 `range` 属性类型说明 1 year ago
layer 补充 `layer.photos()` 方法中的 `hideFooter` 属性 1 year ago
layout 优化 layout 文档细节 1 year ago
laypage 优化 docs 子文档的引用路径 2 years ago
laytpl 添加 laytpl 文档示例中复制代码时缺失的样式和 js 引入 2 years ago
menu 基础菜单menu,文档细节修正 1 year ago
nav 修正 nav 文档中的公共类跳转链接 2 years 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 的 expandedWidth 表头属性描述细节 1 year ago
timeline Add docs 2 years ago
transfer 修正 transfer 的 `height` 默认值错误 2 years ago
tree 更新 `customName` 属性文档介绍 1 year ago
treeTable 调整 treeTable 示例细节 1 year ago
upload 增加 upload 文档中 `text` 属性的介绍 1 year ago
util 优化 util 中的 API 列表 1 year ago
README.md 优化 Docs 内容 2 years 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 添加 v2.8.15 更新日志 1 year ago

README.md

Docs

文档预览

目录规范

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

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

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

书写规范

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

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