github
/
layui
mirror of https://github.com/layui/layui
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
layui/docs
History
贤心 e33b502b62 更新 code 文档内容至 2.8.2+ 2023-05-04 16:21:19 +08:00
..
.layui 优化 Docs 内容，添加引入 `layui.js` 的位置注释 2023-05-03 21:34:15 +08:00
@note/2.8 优化 Docs 内容 2023-05-03 17:17:39 +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 内容，添加引入 `layui.js` 的位置注释 2023-05-03 21:34:15 +08:00
class 公共类文档细节优化 2023-05-03 17:24:01 +08:00
code 更新 code 文档内容至 2.8.2+ 2023-05-04 16:21:19 +08:00
color Add docs 2023-04-24 08:42:47 +08:00
colorpicker 优化 Docs 内容 2023-05-03 17:17:39 +08:00
dropdown 优化 Docs 内容 2023-05-03 17:17:39 +08:00
fixbar Add docs 2023-04-24 08:42:47 +08:00
flow 优化 Docs 内容 2023-05-03 17:17:39 +08:00
form 优化 Docs 内容，添加引入 `layui.js` 的位置注释 2023-05-03 21:34:15 +08:00
icon 优化 icon 文档中的复制提示，并确保代码正常运行（位于 `layui.js` 之前） 2023-04-27 20:39:48 +08:00
laydate 注释 laydate 圆圈主题示例 2023-05-03 20:03:37 +08:00
layer 优化 Docs 内容 2023-05-03 17:17:39 +08:00
layout 优化 Docs 内容 2023-05-03 17:17:39 +08:00
laypage 优化 Docs 内容 2023-05-03 17:17:39 +08:00
laytpl 优化 Docs 内容 2023-05-03 17:17:39 +08:00
menu menu 文档细节优化， type 缺少单引号 2023-05-03 17:18:17 +08:00
nav 优化 Docs 内容，添加引入 `layui.js` 的位置注释 2023-05-03 21:34:15 +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-03 17:17:39 +08:00
slider 优化 Docs 内容 2023-05-03 17:17:39 +08:00
tab 优化 Docs 内容 2023-05-03 17:17:39 +08:00
table Merge pull request #1246 from Sight-wcg/patch-docs 2023-05-03 18:58:35 +08:00
timeline Add docs 2023-04-24 08:42:47 +08:00
transfer 优化 Docs 内容 2023-05-03 17:17:39 +08:00
tree 优化 Docs 内容 2023-05-03 17:17:39 +08:00
treeTable 更新 treeTable 文档内容 2023-05-04 10:04:30 +08:00
upload Merge pull request #1246 from Sight-wcg/patch-docs 2023-05-03 18:58:35 +08:00
util 优化 Docs 内容 2023-05-03 17:17:39 +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 修改 cdn 地址中的 layui 版本号属性 2023-05-04 16:20:26 +08:00
modules.md Add docs 2023-04-24 08:42:47 +08:00
versions.md 添加 v2.8.2 更新日志 2023-05-04 10:27:08 +08:00

README.md

Docs

文档预览

目录规范

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

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

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

书写规范

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

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