lsm/layui
1
0
Fork 0
mirror of https://gitee.com/layui/layui.git synced 2025-10-07 23:24:32 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
Files
aa27f049a76f0e8176a1f7aae7123ed326cf6e48
layui/docs
History
贤心 aa27f049a7 release: v2.9.27
2025-07-21 11:10:28 +08:00
..
.layui
优化 docs 子文档的引用路径
2023-05-10 12:14:45 +08:00
anim
优化 Docs 内容，添加引入 layui.js 的位置注释
2023-05-03 21:34:15 +08:00
auxiliar
Add docs
2023-04-24 08:42:47 +08:00
badge
Add docs
2023-04-24 08:42:47 +08:00
button
更新 button 按钮主题示例
2023-07-13 09:15:24 +08:00
carousel
修正 carousel 文档中的 autoplay 属性可选值
2023-08-18 17:58:39 +08:00
class
fix: 优化 layui-text 在混合列表下的显示问题 (#2510)
2025-02-19 22:49:49 +08:00
code
feat(code): 支持获取复制状态，阻止默认提示 (#2419)
2024-12-25 16:33:52 +08:00
color
color 文档优化
2023-05-13 21:34:21 +08:00
colorpicker
更正 colorpicker 文档说明
2023-08-30 09:52:56 +08:00
dropdown
docs(dropdown): 更新 closeOnClick 默认值
2024-11-25 19:24:10 +08:00
fixbar
更新 docs 中的引入资源
2023-11-29 12:41:17 +08:00
flow
docs(flow): 增加 moreText 选项的版本标识
2024-06-05 22:18:57 +08:00
form
docs(form-select): 更新文档 (#2176)
2024-08-25 22:18:04 +08:00
icon
feat(icon): 新增 6 个图标 (#2511)
2025-02-19 22:50:21 +08:00
laydate
docs: 更新外部资源 CDN URL
2024-10-09 00:23:51 +08:00
layer
fix(layer): 改进 maxWidth 和 maxHeight 的处理 (#2270)
2024-10-11 10:04:05 +08:00
layout
docs: 更新外部资源 CDN URL
2024-10-09 00:23:51 +08:00
laypage
新增 laypage countText 选项 (#1444)
2023-12-06 23:46:50 +08:00
laytpl
fix: 优化 escape 和 unescape 在解析某些特殊字符串时的潜在问题 (#2628)
2025-04-15 13:30:23 +08:00
menu
更新 docs 中的引入资源
2023-11-29 12:41:17 +08:00
nav
feat(element): 支持指定元素渲染 (#2162)
2024-08-16 18:47:19 +08:00
panel
feat(element): 支持指定元素渲染 (#2162)
2024-08-16 18:47:19 +08:00
progress
feat(element): 支持指定元素渲染 (#2162)
2024-08-16 18:47:19 +08:00
rate
优化 docs 子文档的引用路径
2023-05-10 12:14:45 +08:00
slider
feat(silder): 新增提示文本始终显示控制属性 (#1520)
2024-01-03 17:25:48 +08:00
tab
feat(tab): 新增 element.tabDelete() 方法的第三个参数，用于强制删除 tab (#2407)
2024-12-20 16:18:47 +08:00
table
docs(table): 更正示例代码拼写错误
2024-12-02 11:49:15 +08:00
timeline
Add docs
2023-04-24 08:42:47 +08:00
transfer
feat(transfer): 新增 dblclick 选项 (#1491)
2023-12-26 22:32:10 +08:00
tree
更新 customName 属性文档介绍
2023-08-15 21:54:18 +08:00
treeTable
docs(treeTable): 更新 treeTable.checkStatus 文档 (#2426)
2024-12-25 16:03:17 +08:00
upload
docs: 补充文档
2024-08-16 22:07:52 +08:00
util
docs: 优化 util.on() 方法的文档说明
2025-02-14 17:32:43 +08:00
base.md
修正 layui.config() 的示例代码
2023-08-12 19:53:06 +08:00
favicon.ico
新增 Layui 新 LOGO
2023-04-22 16:18:04 +08:00
index.md
docs: 新增 JSDELIVR 资源入口 (#2141)
2024-08-09 18:28:52 +08:00
modules.md
修正 docs 模块说明的错别字
2023-06-21 11:10:12 +08:00
README.md
更新 docs 入口链接
2023-11-06 08:48:37 +08:00
versions.md
release: v2.9.27
2025-07-21 11:10:28 +08:00

README.md

Docs

文档预览

目录规范

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

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

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

书写规范

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

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