克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

docs

1. 介绍

UBML开发者文档,开发者可以在文档中心了解UBML发行版使用教程及低代码开发案例。

文档中心

2. 文档描述文件说明

在目前的文档系统中,我们约定所有的目录及文档都需要在description.ecp中进行描述,description.ecp当前文件夹下,文档和目录的配置文件,未在配置文件中声明的目录和文档不会展示在文档中心中。

2.1 文件配置项

配置文件为description.ecp,配置文件内容整体是一个json,共分为Folders文件夹配置Files文件配置,具体内容如下示例。如:

{
	"Files": [
		{
			"Name": "scene.md", // md文件名称
			"Order": "1", // 当前文件作为文档展示在文档中心目录中的顺序,正整数且不能重复
			"ShowName": "1.场景介绍", // 当前文件作为文档展示在文档中心目录中的文档名称
			"Language": "CN", // 固定字段,标识展示当前文档的语言
			"IsNeedAuth": "false" // 备用字段,可不写或者直接写成false
		},
		{
			"Name": "download.md",
			"Order": "3",
			"ShowName": "3.Demo使用说明",
			"Language": "CN",
			"IsNeedAuth": "false"
		}
	],
	"Folders": [
		{
			"Name": "development-steps", // 当前文件夹名称
			"Order": "2", // 当前文件夹作为目录展示在文档中心的顺序,正整数且不能重复
			"CN": "2.开发过程", // 当前文件夹作为目录展示在文档中心的目录名称
			"EN": "Development Steps", // 备用字段,当前文件夹作为目录展示在文档网站中的目录英文名称
			"IsNeedAuth": "false" // 备用字段
		}
	]
}

对应的文档目录截图如下:

description及文件夹内容

文档网站的目录就是通过一层一层的配置来实现的。

3. 文档的内容编写规范

文档整体与md文件语法一致,部分规范和注意事项如下:

3.1 标题注意事项

  • 1级标题用来标识整个文档大标题

  • 2、3级标题用来标识大小段落,并生成锚点。如图:

  • 对于后续的标题不再限制

3.2 图片的编写

图片的编写推荐使用md工具中的插入图片,每个文档的图片必须在文档所在文件夹的images文件夹下。这样加载文档时会自动将相对路径转换为绝对路径。写法请按照以下格式![图片名称](images/xxxx.png)

3.3 表格的编写

推荐使用html表格语法的编写,或者也可以直接插入图片代替表格

3.4 MD文件的[TOC]语法

在文档中写下[TOC]后,会自动在文档最上方生成一个目录,这个与锚点功能重合,建议使用锚点。

3.5 支持文件夹默认文档的展示

在文件夹下编写default.md后当点击目录时,会打开目录并在右侧展示默认说明文档

4. 参与贡献

  1. Fork 本仓库
  2. 新建 Feat_xxx 分支
  3. 提交代码
  4. 新建 Pull Request

5. 社区活动

5.1 活动一:征文活动,邀请大家一起来「贡献」

活动介绍

如果对参与我们社区文档建设感兴趣,可以搜索文档中心. 参考Gitee上UBML/docs仓库「writing」目录下的示例模板,提交.md类型的文档(大概阐述说明希望增加的说明文档或文档框架,也可以是自己编写的一段文档内容),审核通过后,可以积攒文档贡献值。

  • 社区会评选TOP贡献者,给予社区周边奖励
  • 我们将在被采纳的征文中,留下你的专属徽标
  • 如果对操作过程有疑问,请给我们留言。

5.2 活动二:邀请大家一起来「找茬」

活动介绍

如果对参与我们社区文档建设感兴趣,可以提交issue反馈文档中心现有文档错误或建议。 点击新建issue(需求类、bug或者普通issue等),填充内容后提交。

  • 社区会评选TOP贡献者,给予社区周边奖励
  • 我们将在你修正的文档中,留下你的专属徽标
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

UBML开发者文档 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化