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
贤心 9ff6fe4c6d
优化 layout 文档细节
1 year ago
..
.layui
anim
auxiliar
badge
button
carousel
class
code
color
colorpicker
dropdown
fixbar
flow
form 剔除 checkbox 示例多余的标签 1 year ago
icon
laydate
layer 补充 `layer.photos()` 方法中的 `hideFooter` 属性 1 year ago
layout 优化 layout 文档细节 1 year ago
laypage
laytpl
menu
nav
panel
progress
rate
slider
tab
table 微调 table 示例细节 1 year ago
timeline
transfer
tree
treeTable 修正 treeTable 文档单词拼写错误 1 year ago
upload 更细 upload 文档的 `unified` 属性介绍 1 year ago
util 优化 util 文档示例 1 year ago
README.md
base.md
favicon.ico
index.md 微调 docs 简介文案 1 year ago
modules.md 修正 docs 模块说明的错别字 1 year ago
versions.md 更新 v2.8.8 下载包链接 1 year ago

README.md

Docs

文档预览

目录规范

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

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

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

书写规范

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

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