History

贤心 2034f2415d 更新 layer 文档		2023-05-15 11:33:42 +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	Add docs	2023-04-24 08:42:47 +08:00
carousel	优化 docs 子文档的引用路径	2023-05-10 12:14:45 +08:00
class	公共类文档细节优化	2023-05-03 17:24:01 +08:00
code	优化 docs 子文档的引用路径	2023-05-10 12:14:45 +08:00
color	color 文档优化	2023-05-13 21:34:21 +08:00
colorpicker	优化 docs 子文档的引用路径	2023-05-10 12:14:45 +08:00
dropdown	修改 docs 示例中的静态模拟数据的路径	2023-05-10 12:56:43 +08:00
fixbar	优化 docs 子文档的引用路径	2023-05-10 12:14:45 +08:00
flow	优化 docs 子文档的引用路径	2023-05-10 12:14:45 +08:00
form	优化 docs 子文档的引用路径	2023-05-10 12:14:45 +08:00
icon	优化 icon 文档中的复制提示，并确保代码正常运行（位于 `layui.js` 之前）	2023-04-27 20:39:48 +08:00
laydate	优化 docs 子文档的引用路径	2023-05-10 12:14:45 +08:00
layer	更新 layer 文档	2023-05-15 11:33:42 +08:00
layout	优化 Docs 内容	2023-05-03 17:17:39 +08:00
laypage	优化 docs 子文档的引用路径	2023-05-10 12:14:45 +08:00
laytpl	优化 docs 子文档的引用路径	2023-05-10 12:14:45 +08:00
menu	优化 docs 子文档的引用路径	2023-05-10 12:14:45 +08:00
nav	修正 nav 文档中的公共类跳转链接	2023-05-10 15:31:34 +08:00
panel	优化 Docs 内容，添加引入 `layui.js` 的位置注释	2023-05-03 21:34:15 +08:00
progress	优化 Docs 内容，添加引入 `layui.js` 的位置注释	2023-05-03 21:34:15 +08:00
rate	优化 docs 子文档的引用路径	2023-05-10 12:14:45 +08:00
slider	优化 docs 子文档的引用路径	2023-05-10 12:14:45 +08:00
tab	优化 docs 子文档的引用路径	2023-05-10 12:14:45 +08:00
table	更新 table 文档	2023-05-15 11:33:12 +08:00
timeline	Add docs	2023-04-24 08:42:47 +08:00
transfer	优化 docs 子文档的引用路径	2023-05-10 12:14:45 +08:00
tree	修改 docs 示例中的静态模拟数据的路径	2023-05-10 12:56:43 +08:00
treeTable	修改 docs 示例中的静态模拟数据的路径	2023-05-10 12:56:43 +08:00
upload	优化 docs 子文档的引用路径	2023-05-10 12:14:45 +08:00
util	优化 docs 子文档的引用路径	2023-05-10 12:14:45 +08:00
README.md	优化 Docs 内容	2023-05-03 17:17:39 +08:00
base.md	Add docs	2023-04-24 08:42:47 +08:00
favicon.ico	新增 Layui 新 LOGO	2023-04-22 16:18:04 +08:00
index.md	优化 docs 官网下载入口	2023-05-10 12:15:15 +08:00
modules.md	Add docs	2023-04-24 08:42:47 +08:00
versions.md	修改导读的 URL	2023-05-10 12:16:46 +08:00

README.md

Docs

文档预览

目录规范

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

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

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

书写规范

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

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