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
贤心 a8b6b9c696
docs: 新增 JSDELIVR 资源入口 (#2141)
4 months ago
..
.layui
anim
auxiliar
badge
button
carousel
class
code
color
colorpicker
dropdown
fixbar
flow docs(flow): 增加 moreText 选项的版本标识 6 months ago
form feat(form-select): 改进 lay-search 属性,支持设置「是否大小写敏感」和「模糊搜索」 4 months ago
icon
laydate docs(laydate): 修改日期组件 isInitValue 默认值 #2016 5 months ago
layer feat(layer): 新增 btnAsync 选项 (#2002) 6 months ago
layout chore: 更新 staticfile 最新 cdn 域名 6 months ago
laypage
laytpl
menu
nav
panel
progress
rate
slider
tab feat(element-tab): 新增 tab 切换前的事件 (#2111) 4 months ago
table docs: 文档细微优化 (#2094) 4 months ago
timeline
transfer
tree
treeTable
upload feat(upload): error 回调函数增加返回值参数 (#1988) 6 months ago
util
README.md
base.md
favicon.ico
index.md docs: 新增 JSDELIVR 资源入口 (#2141) 4 months ago
modules.md
versions.md docs: 文档细微优化 (#2094) 4 months ago

README.md

Docs

文档预览

目录规范

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

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

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

书写规范

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

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