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
贤心 597d689f23
添加 upload 文档预留元素
1 year ago
..
.layui
anim
auxiliar
badge
button 更新 button 按钮主题示例 1 year ago
carousel 修正 carousel 文档中的 `autoplay` 属性可选值 1 year ago
class
code
color
colorpicker 更正 colorpicker 文档说明 1 year ago
dropdown 更新 `customName` 属性文档介绍 1 year ago
fixbar
flow
form 更新 form 文档介绍 1 year ago
icon
laydate 修正 `laydate.close()` 文档书写错误 1 year ago
layer 更新 layer 示例图片地址 1 year ago
layout 优化 layout 文档细节 1 year ago
laypage
laytpl
menu 基础菜单menu,文档细节修正 1 year ago
nav
panel
progress
rate
slider
tab 完善 tab 文档中的示例的资源引入 1 year ago
table 添加 table 文档预留元素 1 year ago
timeline
transfer
tree 更新 `customName` 属性文档介绍 1 year ago
treeTable 更新 treeTable 属性说明 1 year ago
upload 添加 upload 文档预留元素 1 year ago
util 优化 util 中的 API 列表 1 year ago
README.md
base.md 修正 `layui.config()` 的示例代码 1 year ago
favicon.ico
index.md 微调 docs 首页目录 1 year ago
modules.md
versions.md 更正 version 更新日志中的错别字 1 year ago

README.md

Docs

文档预览

目录规范

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

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

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

书写规范

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

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