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
贤心 f3d68a4e86
release: v2.9.18
1 month ago
..
.layui
anim
auxiliar
badge
button
carousel
class
code
color
colorpicker
dropdown docs(dropdown): 优化 onClickOutside 回调的文档描述 1 month ago
fixbar
flow
form docs(form-select): 更新文档 (#2176) 3 months ago
icon
laydate docs: 更新外部资源 CDN URL 2 months ago
layer fix(layer): 改进 maxWidth 和 maxHeight 的处理 (#2270) 1 month ago
layout docs: 更新外部资源 CDN URL 2 months ago
laypage
laytpl
menu
nav feat(element): 支持指定元素渲染 (#2162) 3 months ago
panel feat(element): 支持指定元素渲染 (#2162) 3 months ago
progress feat(element): 支持指定元素渲染 (#2162) 3 months ago
rate
slider
tab docs: 补充文档 3 months ago
table feat(table): 优化 table.checkStatus() 方法 (#2239) 2 months ago
timeline
transfer
tree
treeTable
upload docs: 补充文档 3 months ago
util
README.md
base.md
favicon.ico
index.md
modules.md
versions.md release: v2.9.18 1 month ago

README.md

Docs

文档预览

目录规范

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

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

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

书写规范

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

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