fix: docs order & some docs lint problems

This commit is contained in:
eternalsky 2023-01-11 17:01:41 +08:00 committed by 林熠
parent 1cfb388e30
commit 0dc59e86a4
4 changed files with 30 additions and 25 deletions

View File

@ -43,7 +43,7 @@ sidebar_position: 4
- `开启缓存` : 可充分利用之前的构建结果缓存来加速资产包的生成,我们会将每个组件的构建结果以 包名和版本号为 key 进行缓存。 - `开启缓存` : 可充分利用之前的构建结果缓存来加速资产包的生成,我们会将每个组件的构建结果以 包名和版本号为 key 进行缓存。
- `任务描述` : 当前构建任务的一些描述信息。 - `任务描述` : 当前构建任务的一些描述信息。
点击 `确认` 按钮 会自动跳转到当前资产包的构建历史界面: 点击 `确认` 按钮 会自动跳转到当前资产包的构建历史界面
![image.png](https://img.alicdn.com/imgextra/i2/O1CN01krDaFc1TuTztMPssI_!!6000000002442-2-tps-1726-696.png) ![image.png](https://img.alicdn.com/imgextra/i2/O1CN01krDaFc1TuTztMPssI_!!6000000002442-2-tps-1726-696.png)
构建历史界面会显示当前资产包所有的构建历史记录,表格状态栏展示了构建的状态:`成功`,`失败`,`正在运行` 三种状态,操作列可以在构建成功时复制或者下载资产包结果 构建历史界面会显示当前资产包所有的构建历史记录,表格状态栏展示了构建的状态:`成功`,`失败`,`正在运行` 三种状态,操作列可以在构建成功时复制或者下载资产包结果
@ -125,7 +125,7 @@ const SamplePreview = () => {
ReactDOM.render(<SamplePreview />, document.getElementById('ice-container')); ReactDOM.render(<SamplePreview />, document.getElementById('ice-container'));
``` ```
从资产包中解析 react 组件列表的逻辑如下, [详见](https://github.com/alibaba/lowcode-demo/blob/main/demo-lowcode-component/src/parse-assets.ts) 从资产包中解析 react 组件列表的逻辑如下[详见](https://github.com/alibaba/lowcode-demo/blob/main/demo-lowcode-component/src/parse-assets.ts)
```ts ```ts
import { ComponentDescription, ComponentSchema, RemoteComponentDescription } from '@alilc/lowcode-types'; import { ComponentDescription, ComponentSchema, RemoteComponentDescription } from '@alilc/lowcode-types';
import { buildComponents, AssetsJson, AssetLoader } from '@alilc/lowcode-utils'; import { buildComponents, AssetsJson, AssetLoader } from '@alilc/lowcode-utils';

View File

@ -104,7 +104,7 @@ sidebar_position: 3
第三步:物料描述发布完成后,接下来我们就需要构建出可用的资产包用于低代码应用中。 第三步:物料描述发布完成后,接下来我们就需要构建出可用的资产包用于低代码应用中。
#### 资产包构建 #### 资产包构建
有两种方式可以构建资产包: 有两种方式可以构建资产包
- 一种是通过 [`我的资产包`] 资产包管理模块进行整个资产包生命周期的管理,当然也包括资产包的构建,可参考 [资产包管理](./partsassets) - 一种是通过 [`我的资产包`] 资产包管理模块进行整个资产包生命周期的管理,当然也包括资产包的构建,可参考 [资产包管理](./partsassets)
- 一种是通过 [`我的物料`] 组件物料管理模块的 `资产包构建` 进行构建, 具体操作如下: - 一种是通过 [`我的物料`] 组件物料管理模块的 `资产包构建` 进行构建, 具体操作如下:

View File

@ -8,9 +8,14 @@ module.exports = function getDocsFromDir(dir, cateList) {
const baseDir = path.join(__dirname, '../docs/'); const baseDir = path.join(__dirname, '../docs/');
const docsDir = path.join(baseDir, dir); const docsDir = path.join(baseDir, dir);
function isNil(value) {
return value === undefined || value === null;
}
function getMarkdownOrder(filepath) { function getMarkdownOrder(filepath) {
const data = matter(fs.readFileSync(filepath, 'utf-8')).data; const { data } = matter(fs.readFileSync(filepath, 'utf-8'));
return (data || {}).sidebar_position || 100; const { sidebar_position } = data || {};
return isNil(sidebar_position) ? 100 : sidebar_position;
} }
const docs = glob.sync('*.md?(x)', { const docs = glob.sync('*.md?(x)', {
@ -19,17 +24,17 @@ module.exports = function getDocsFromDir(dir, cateList) {
}); });
const result = docs const result = docs
.filter(doc => !/^index.md(x)?$/.test(doc)) .filter((doc) => !/^index.md(x)?$/.test(doc))
.map(doc => { .map((doc) => {
return path.join(docsDir, doc); return path.join(docsDir, doc);
}) })
.sort((a, b) => { .sort((a, b) => {
const orderA = getMarkdownOrder(a); const orderA = getMarkdownOrder(a);
const orderB = getMarkdownOrder(b); const orderB = getMarkdownOrder(b);
return orderB - orderA; return orderA - orderB;
}) })
.map(filepath => { .map((filepath) => {
// /Users/xxx/site/docs/guide/basic/router.md => guide/basic/router // /Users/xxx/site/docs/guide/basic/router.md => guide/basic/router
const id = path const id = path
.relative(baseDir, filepath) .relative(baseDir, filepath)
@ -38,7 +43,7 @@ module.exports = function getDocsFromDir(dir, cateList) {
return id; return id;
}); });
(cateList || []).forEach(item => { (cateList || []).forEach((item) => {
const { dir, subCategory, ...otherConfig } = item; const { dir, subCategory, ...otherConfig } = item;
const indexList = glob.sync('index.md?(x)', { const indexList = glob.sync('index.md?(x)', {
cwd: path.join(baseDir, dir), cwd: path.join(baseDir, dir),