From 727fb8305e64e812e924493a6d034fd669cdc076 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=B4=A4=E5=BF=83?= <3277200+sentsim@users.noreply.github.com> Date: Wed, 3 May 2023 17:17:39 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BC=98=E5=8C=96=20Docs=20=E5=86=85=E5=AE=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.layui/DOCS_TEMPLATE.md | 34 ------------------------ docs/.layui/DOCS_TEMPLATE_DEMO.md | 27 ------------------- docs/.layui/DOCS_TEMPLATE_OPTIONS.md | 32 ---------------------- docs/@note/2.8/news.md | 21 ++++++++++++--- docs/@note/2.8/upgrade-guide.md | 14 ++++++++-- docs/README.md | 22 ++++++++++++++- docs/anim/index.md | 4 ++- docs/carousel/detail/demo.md | 5 +++- docs/code/index.md | 3 ++- docs/colorpicker/detail/demo.md | 16 +++++++++++ docs/colorpicker/index.md | 3 ++- docs/dropdown/examples/align.md | 1 + docs/dropdown/examples/base.md | 1 + docs/dropdown/examples/complex.md | 1 + docs/dropdown/examples/content.md | 3 ++- docs/dropdown/examples/contextmenu.md | 1 + docs/dropdown/examples/on.md | 1 + docs/dropdown/examples/reload.md | 1 + docs/dropdown/examples/reloadData.md | 1 + docs/dropdown/examples/table.md | 1 + docs/dropdown/index.md | 3 ++- docs/flow/detail/demo.md | 4 +++ docs/flow/index.md | 2 ++ docs/form/checkbox.md | 1 + docs/form/examples/form.demo.md | 1 + docs/form/examples/form.grid.md | 3 ++- docs/form/examples/form.login.md | 1 + docs/form/examples/form.pane.md | 3 ++- docs/form/examples/form.reg.md | 3 ++- docs/form/examples/form.val.md | 1 + docs/form/examples/form.validate.md | 3 ++- docs/form/examples/form.verify.md | 3 ++- docs/form/examples/input.affix.custom.md | 1 + docs/form/index.md | 4 +++ docs/form/radio.md | 1 + docs/form/select.md | 1 + docs/index.md | 3 ++- docs/laydate/examples/elem.md | 1 + docs/laydate/examples/format.md | 1 + docs/laydate/examples/limit.md | 1 + docs/laydate/examples/mark.md | 1 + docs/laydate/examples/more.md | 1 + docs/laydate/examples/normal.md | 1 + docs/laydate/examples/range.md | 1 + docs/laydate/examples/shortcut.md | 1 + docs/laydate/examples/static.md | 1 + docs/laydate/examples/theme.md | 1 + docs/laydate/examples/type.md | 1 + docs/laydate/index.md | 1 + docs/layer/examples/alert.md | 1 + docs/layer/examples/direction.md | 1 + docs/layer/examples/iframe.md | 1 + docs/layer/examples/load.md | 1 + docs/layer/examples/more.md | 1 + docs/layer/examples/offset.md | 1 + docs/layer/examples/other.md | 1 + docs/layer/examples/page.md | 1 + docs/layer/examples/skin.md | 1 + docs/layer/examples/tips.md | 1 + docs/layer/examples/type.md | 1 + docs/layer/index.md | 1 + docs/layout/index.md | 1 + docs/laypage/detail/demo.md | 20 ++++++++++++++ docs/laytpl/index.md | 1 + docs/nav/examples/side.md | 1 + docs/nav/index.md | 4 +++ docs/panel/index.md | 1 + docs/progress/index.md | 5 +++- docs/rate/detail/demo.md | 13 +++++++++ docs/rate/index.md | 1 + docs/slider/detail/demo.md | 20 ++++++++++++++ docs/slider/index.md | 1 + docs/tab/detail/demo.md | 8 ++++-- docs/tab/index.md | 5 ++++ docs/table/examples/autoRender.md | 4 ++- docs/table/examples/data.md | 3 ++- docs/table/examples/editModes.md | 3 ++- docs/table/examples/editable.md | 3 ++- docs/table/examples/filter.md | 3 ++- docs/table/examples/init.md | 3 ++- docs/table/examples/onrowContextmenu.md | 1 + docs/table/examples/page.md | 3 ++- docs/table/examples/parse.md | 1 + docs/table/examples/search.md | 3 ++- docs/table/examples/setRowChecked.md | 1 + docs/table/examples/templet.md | 3 ++- docs/table/examples/theads.md | 4 ++- docs/table/index.md | 8 ++++-- docs/transfer/detail/demo.md | 14 ++++++++++ docs/tree/detail/demo.md | 9 +++++++ docs/treeTable/examples/demo.md | 1 + docs/upload/examples/accept.md | 1 + docs/upload/examples/auto.md | 1 + docs/upload/examples/drag.md | 1 + docs/upload/examples/files.table.md | 3 ++- docs/upload/examples/form.file.md | 3 ++- docs/upload/examples/image.md | 3 ++- docs/upload/examples/size.md | 1 + docs/upload/index.md | 1 + docs/util/detail/demo.md | 3 ++- docs/util/index.md | 3 ++- docs/versions.md | 4 +-- 102 files changed, 292 insertions(+), 134 deletions(-) delete mode 100644 docs/.layui/DOCS_TEMPLATE.md delete mode 100644 docs/.layui/DOCS_TEMPLATE_DEMO.md delete mode 100644 docs/.layui/DOCS_TEMPLATE_OPTIONS.md diff --git a/docs/.layui/DOCS_TEMPLATE.md b/docs/.layui/DOCS_TEMPLATE.md deleted file mode 100644 index cc913bd9..00000000 --- a/docs/.layui/DOCS_TEMPLATE.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: 某某组件 MOD_NAME -toc: true ---- - -# 某某组件 - -> 某某组件 `MOD_NAME` - -

示例

- -
-{{- d.include("docs/MOD_NAME/detail/demo.md") }} -
- -

API

- -| API | 描述 | -| --- | --- | -| var MOD_NAME = layui.MOD_NAME | 获得 `MOD_NAME` 模块。 | -| [MOD_NAME.render(options)](#render) | MOD_NAME 组件渲染，核心方法。 | -| …… | …… | - -

渲染

- -`MOD_NAME.render(options);` - -- 参数 `options` : 基础属性配置项。[#详见属性](#options) - -

属性

- -
-{{- d.include("docs/MOD_NAME/detail/options.md") }} -
\ No newline at end of file diff --git a/docs/.layui/DOCS_TEMPLATE_DEMO.md b/docs/.layui/DOCS_TEMPLATE_DEMO.md deleted file mode 100644 index 7422e072..00000000 --- a/docs/.layui/DOCS_TEMPLATE_DEMO.md +++ /dev/null @@ -1,27 +0,0 @@ -
-  
-
- -

示例标题

- -
-  
-
\ No newline at end of file diff --git a/docs/.layui/DOCS_TEMPLATE_OPTIONS.md b/docs/.layui/DOCS_TEMPLATE_OPTIONS.md deleted file mode 100644 index 2ccee5ab..00000000 --- a/docs/.layui/DOCS_TEMPLATE_OPTIONS.md +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - -
属性名描述类型默认值
AAA - - - -CCC - - - -
\ No newline at end of file diff --git a/docs/@note/2.8/news.md b/docs/@note/2.8/news.md index 4ae89054..7ee232e7 100644 --- a/docs/@note/2.8/news.md +++ b/docs/@note/2.8/news.md @@ -1,21 +1,34 @@ --- -title: 🚀 Layui 2.8.0 正式发布，朴实归来 +title: 🚀 Layui 2.8.0 正式发布，全新文档站朴实归来 toc: false --- -# 🚀 Layui 2.8.0 正式发布，朴实归来 +# 🚀 Layui 2.8.0 正式发布，全新文档站朴实归来 + +

+ 发布：2023-04-24 +

我们终于迎来了 Layui `2.8.0` 的正式版本，以及全新的文档站。 在 Layui 过往七年的开源历程中，从未用多达**二十个预览版**去为一个正式版而引路。 显然，`2.8.0` 是 Layui 一次朴实的回归，更是情怀的延续。但却并不是想以此呼吁人们重新去选择它，我们仍然坚持两年前那则《[Layui 原官网下线公告](https://unpkg.com/outeres@0.0.7/img/layui/notice-2021.png)》中的观点， _即仍然推荐大家去拥抱主流，始终保持对前沿技术的无限热爱，是开发者们都应具备的思维属性_。 **而 Layui 所做的，是为填补主流之外的那些略显狭小的空隙**。 -Layui 虽然并不是前端主流，但也早已不是作者个人的 Layui，而是所有仍在坚持使用它的人的 Layui，它仍然支撑着许多项目，也代表着许多人的工作，作为开源创作者的我们，应该要为这些坚持者而守望。 +Layui 虽不是前端主流，但也早已不是作者个人的 Layui，而是所有仍在坚持使用它的人的 Layui，它仍然支撑着许多项目，也代表着许多人的工作，作为开源创作者的我们，应该要为这些坚持者而守望。 ### 新文档站 -在 2021 年 Layui 原官网下线后，互联网出现了许多第三方的 Layui 文档镜像站点，这在当时，给大家能继续阅读文档确实提供了便利，但原官网的下线，只是单纯一个网站自身生命周期的结束，它并不意味着 Layui 这样一个开源项目的停更，当时的公告其实也说的很清楚了，但或许是由于那则公告的用词过于「悲壮」，使得各大自媒体有所误读，从而让大家都以为是 Layui 停更了。 事实上，自那以后，Layui 仍然在 Github 和 Gitee 保持活跃，并不存在所谓的停止更新，甚至从 `2.6.9` 一直迭代到今天的 `2.8.0`，而现存的第三方文档镜像站点的内容却仍然定格在 Layui `2.6.8` 的版本，已严重滞后于 Layui 的当前版本，显然是不利于开发者们对 Layui 的应用。 两年来，Layui 始终处于没有中心文档的窘迫境地，虽然也一度以 **Gitee Pages** 为文档的承载，但似乎很难形成一个焦点和归属感。 随着 `2.8.0` 正式版本的发布，它所包含的上百项的更新内容，使得全新的文档站点呼之欲出。 +2021 年 Layui 原官网下线后，互联网出现了许多第三方的 Layui 文档镜像站，这在当时，给大家能继续阅读文档确实提供了便利，但原官网的下线，只是单纯一个网站自身生命周期的结束，它并不意味着 Layui 这样一个开源项目的停更，这在公告中也有清晰的阐述。但或许是由于那则公告的用词过于「悲壮」，使得各大自媒体有所误读，从而让大家都以为是 Layui 停更了。 事实上，自那以后，Layui 仍然在 Github 和 Gitee 保持活跃，并不存在所谓的停止更新，甚至从 `2.6.9` 一直迭代到今天的最新版本，而现存的第三方文档镜像站点的内容却仍然定格在 Layui `2.6.8` 的版本，已严重滞后于 Layui 的当前版本，显然是不利于开发者们对 Layui 的应用。 两年来，Layui 始终处于没有中心文档的窘迫境地，虽然也一度以 **Gitee Pages** 为文档的承载，但似乎很难形成一个焦点和归属感。 随着 `2.8.0` 正式版本的发布，它所包含的上百项的内容更新，使得全新的文档站呼之欲出。 此次上线的新版文档站，旨在为朴实归来的 Layui 提供一个新的精神「基站」，它基于 laytpl 和 markdown 驱动，在版面上进行了大量优化，内容重新编写、力求精简，以辅助大家更好地使用 Layui。 同时，Layui 文档也已和 Layui 本身一同开源在项目中，以供大家在线和离线都能阅读以及协同维护。 - **文档协作:** https://github.com/layui/layui/tree/main/docs - **文档阅读:** https://layui.dev + +--- + +
+ 我要评论 + + 更新日志 + +
diff --git a/docs/@note/2.8/upgrade-guide.md b/docs/@note/2.8/upgrade-guide.md index 38ac8486..0eefd17a 100644 --- a/docs/@note/2.8/upgrade-guide.md +++ b/docs/@note/2.8/upgrade-guide.md @@ -1,9 +1,9 @@ --- -title: Layui 2.8 《升级指南》 +title: 📑 Layui 2.8 《升级指南》 toc: false --- -# Layui 2.8 《升级指南》 +# 📑 Layui 2.8 《升级指南》 Layui `2.8` 总体向下兼容，但仍有以下变更需要注意： @@ -42,3 +42,13 @@ Layui `2.8` 总体向下兼容，但仍有以下变更需要注意： https://layui.dev/docs/versions.html 或新建 `Issue` 进行详细反馈。 + +--- + +
+ 前往 Issues + + 更新日志 + +
+ diff --git a/docs/README.md b/docs/README.md index ab7ba5a0..e078a35b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,24 @@ # Docs +## 文档预览 + - [最新文档](https://layui.dev) -- [2.7 文档](https://layui.dev/2.7/) \ No newline at end of file +- [2.7 文档](https://layui.dev/2.7/) + +## 目录规范 + +文档的目录与文件命名，需与组件的命名对应。子目录可自由发挥，但一般可参考以下规则： + +- `index.md` 组件主文件 +- `detail/` 组件详情文件。一般在主文件内容过大时，可将内容碎片放置在该目录中，主文件只需引用即可。 +- `examples/` 组件示例文件。 + +当创建新的组件文档时，可复制 `.layui/` 目录中放置好的文档模板，并填充对应的内容。 + +## 书写规范 + +文档采用 `HTML+Markdown+laytpl` 混合编写。 其中： + +- `HTML` 标签与 `Markdown` 混用时，必须换两行隔开 +- `laytpl` 标签语法可直接遵循 Layui 中的 laytpl 组件规则 +- 若需开启文档的右侧目录，可在对应锚点元素上添加 `lay-toc="{}"` 属性即可，具体可参考其他组件中的内容 \ No newline at end of file diff --git a/docs/anim/index.md b/docs/anim/index.md index 43d2de98..93bce696 100644 --- a/docs/anim/index.md +++ b/docs/anim/index.md @@ -16,7 +16,7 @@ toc: true

示例

-
+
   
 

 
@@ -154,6 +156,8 @@ tab 组件会在元素加载完毕后，自动对 tab 元素完成一次渲染
 
 ```
 

+ 
+
 !}}
- 
+
+
 
- 
+
+
 
 
+
 
- 
+
+
 
\ No newline at end of file
+
+
+
\ No newline at end of file
diff --git a/docs/table/index.md b/docs/table/index.md
index 17f12cec..bf594a80 100644
--- a/docs/table/index.md
+++ b/docs/table/index.md
@@ -54,9 +54,10 @@ table 提供了以下三种渲染模式，在实际使用时，一般按情况
 
 该方法返回当前实例对象，包含可操作当前表格的一些成员方法。
 
-```
+```html
 

  
+
 
  
+
 
 
+