mirror of https://github.com/layui/layui
24 lines
926 B
Markdown
24 lines
926 B
Markdown
# Docs
|
|
|
|
## 文档预览
|
|
|
|
- [最新文档](https://layui.dev)
|
|
- [2.7 文档](https://layui.dev/2.7/)
|
|
|
|
## 目录规范
|
|
|
|
文档的目录与文件命名，需与组件的命名对应。子目录可自由发挥，但一般可参考以下规则：
|
|
|
|
- `index.md` 组件主文件
|
|
- `detail/` 组件详情文件。一般在主文件内容过大时，可将内容碎片放置在该目录中，主文件只需引用即可。
|
|
- `examples/` 组件示例文件。
|
|
|
|
当创建新的组件文档时，可复制 `.layui/` 目录中放置好的文档模板，并填充对应的内容。
|
|
|
|
## 书写规范
|
|
|
|
文档采用 `HTML+Markdown+laytpl` 混合编写。 其中：
|
|
|
|
- `HTML` 标签与 `Markdown` 混用时，必须换两行隔开
|
|
- `laytpl` 标签语法可直接遵循 Layui 中的 laytpl 组件规则
|
|
- 若需开启文档的右侧目录，可在对应锚点元素上添加 `lay-toc="{}"` 属性即可，具体可参考其他组件中的内容 |