History

zy b38c607bb5 first		2025-11-10 09:40:09 +08:00
..
.layui	first	2025-11-10 09:40:09 +08:00
@note/2.8	first	2025-11-10 09:40:09 +08:00
anim	first	2025-11-10 09:40:09 +08:00
auxiliar	first	2025-11-10 09:40:09 +08:00
badge	first	2025-11-10 09:40:09 +08:00
button	first	2025-11-10 09:40:09 +08:00
carousel	first	2025-11-10 09:40:09 +08:00
class	first	2025-11-10 09:40:09 +08:00
code	first	2025-11-10 09:40:09 +08:00
color	first	2025-11-10 09:40:09 +08:00
colorpicker	first	2025-11-10 09:40:09 +08:00
dropdown	first	2025-11-10 09:40:09 +08:00
fixbar	first	2025-11-10 09:40:09 +08:00
flow	first	2025-11-10 09:40:09 +08:00
form	first	2025-11-10 09:40:09 +08:00
icon	first	2025-11-10 09:40:09 +08:00
laydate	first	2025-11-10 09:40:09 +08:00
layer	first	2025-11-10 09:40:09 +08:00
layout	first	2025-11-10 09:40:09 +08:00
laypage	first	2025-11-10 09:40:09 +08:00
laytpl	first	2025-11-10 09:40:09 +08:00
menu	first	2025-11-10 09:40:09 +08:00
nav	first	2025-11-10 09:40:09 +08:00
panel	first	2025-11-10 09:40:09 +08:00
progress	first	2025-11-10 09:40:09 +08:00
rate	first	2025-11-10 09:40:09 +08:00
slider	first	2025-11-10 09:40:09 +08:00
tab	first	2025-11-10 09:40:09 +08:00
table	first	2025-11-10 09:40:09 +08:00
timeline	first	2025-11-10 09:40:09 +08:00
transfer	first	2025-11-10 09:40:09 +08:00
tree	first	2025-11-10 09:40:09 +08:00
treeTable	first	2025-11-10 09:40:09 +08:00
upload	first	2025-11-10 09:40:09 +08:00
util	first	2025-11-10 09:40:09 +08:00
README.md	first	2025-11-10 09:40:09 +08:00
base.md	first	2025-11-10 09:40:09 +08:00
favicon.ico	first	2025-11-10 09:40:09 +08:00
index.md	first	2025-11-10 09:40:09 +08:00
modules.md	first	2025-11-10 09:40:09 +08:00
versions.md	first	2025-11-10 09:40:09 +08:00

README.md

Docs

文档预览

目录规范

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

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

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

书写规范

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

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