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
贤心 1b8a033557
丰富 table 文档关于 `renderData` 方法的介绍
1 year ago
..
.layui 优化 docs 子文档的引用路径 2 years ago
anim 优化 Docs 内容,添加引入 `layui.js` 的位置注释 2 years ago
auxiliar
badge
button
carousel 优化 docs 子文档的引用路径 2 years ago
class 公共类文档细节优化 2 years ago
code 优化 docs 子文档的引用路径 2 years ago
color color 文档优化 2 years ago
colorpicker 优化 docs 子文档的引用路径 2 years ago
dropdown 完善 部分组件的 `id` 属性介绍 1 year ago
fixbar 优化 docs 子文档的引用路径 2 years ago
flow 优化 docs 子文档的引用路径 2 years ago
form 完善 form 文档 2 years ago
icon
laydate 完善 部分组件的 `id` 属性介绍 1 year ago
layer 完善 layer 关于弹出层类型的文档说明 2 years ago
layout
laypage 优化 docs 子文档的引用路径 2 years ago
laytpl 添加 laytpl 文档示例中复制代码时缺失的样式和 js 引入 2 years ago
menu 优化 docs 子文档的引用路径 2 years ago
nav 修正 nav 文档中的公共类跳转链接 2 years ago
panel 优化 Docs 内容,添加引入 `layui.js` 的位置注释 2 years ago
progress 优化 Docs 内容,添加引入 `layui.js` 的位置注释 2 years ago
rate 优化 docs 子文档的引用路径 2 years ago
slider 优化 docs 子文档的引用路径 2 years ago
tab 丰富 tab 文档内容 1 year ago
table 丰富 table 文档关于 `renderData` 方法的介绍 1 year ago
timeline
transfer 修正 transfer 的 `height` 默认值错误 2 years ago
tree 修改 docs 示例中的静态模拟数据的路径 2 years ago
treeTable 更新 treeTable 文档 2 years ago
upload 更新 upload 文档的 `exts` 属性说明 2 years ago
util 优化 docs 子文档的引用路径 2 years ago
README.md
base.md 更新 基础方法文档 2 years ago
favicon.ico
index.md 微调 docs 简介文案 1 year ago
modules.md
versions.md 添加 v2.8.4 更新日志 2 years ago

README.md

Docs

文档预览

目录规范

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

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

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

书写规范

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

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