layui/docs
贤心 95a0503f41 Merge branch 'main' into 2.x 2025-03-19 14:03:13 +08:00
..
.layui docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +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 docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
class fix: 修正 layui-ellip 类名简写 (#2557) 2025-03-13 14:16:47 +08:00
code docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
color color 文档优化 2023-05-13 21:34:21 +08:00
colorpicker docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
component docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
dropdown docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
fixbar docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
flow docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
form docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
icon feat(icon): 新增 6 个图标 (#2511) 2025-02-19 22:50:21 +08:00
laydate docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
layer docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
layout docs: 更新外部资源 CDN URL 2024-10-09 00:23:51 +08:00
laypage docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
laytpl docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +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 docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
progress feat(element): 支持指定元素渲染 (#2162) 2024-08-16 18:47:19 +08:00
rate docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
slider Merge branch 'main' into 2.x 2025-03-19 14:03:13 +08:00
tab docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
table docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
tabs docs: 修复 tabs 文档示例异常问题 2025-03-19 13:37:29 +08:00
timeline Add docs 2023-04-24 08:42:47 +08:00
transfer docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
tree docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
treeTable docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
upload docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
util docs: 优化文档中的用词细节 (#2571) 2025-03-19 13:29:09 +08:00
README.md 更新 docs 入口链接 2023-11-06 08:48:37 +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: 更新浏览器兼容性说明 2025-03-10 13:53:37 +08:00
modules.md 修正 docs 模块说明的错别字 2023-06-21 11:10:12 +08:00
versions.md docs(version): 优化 2.9.x 锚点 2025-03-19 13:41:33 +08:00

README.md

Docs

文档预览

目录规范

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

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

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

书写规范

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

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