扫描规则
大约 4 分钟
扫描规则
这里说明了 @hz-9/docs-build 会扫描哪些哪些路径，从而生成为文档。
扫描文件 列中，存在多个文件时，以从上到下的顺序匹配。
${baseUrl} 相当于 --base-url 参数。默认为 /，应传入 /tool/ 格式的参数。
${workspace} 相当于 process.cwd() 或 --root 参数。
${docsSpace} 通常为 ${workspace}/docs/.vuepress 路径，为自动创建文件夹，添加至 .gitignore 中。
${projectFolder} 为在 Rush.js 项目中的相对路径。
${unscopedPackageName} 视为不包括 scope 的包名称。
普通项目
| 访问地址 | 扫描文件 | 移动后路径 |
|---|---|---|
http://127.0.0.1${baseUrl} | ${workspace}/docs/README.md${workspace}/README.md | ${docsSpace}/src/README.md |
http://127.0.0.1${baseUrl}zh-CN | ${workspace}/docs/README.zh-CN.md${workspace}/README.zh-CN.md${workspace}/docs/README.md${workspace}/README.md | ${docsSpace}/src/zh-CN/README.md |
http://127.0.0.1${baseUrl}overview | ${workspace}/docs/overview/*.md | ${docsSpace}/src/overview/*.md |
http://127.0.0.1${baseUrl}zh-CN/overview | ${workspace}/docs/overview/*.zh-CN.md${workspace}/docs/overview/*.md | ${docsSpace}/src/zh-CN/overview/*.md |
http://127.0.0.1${baseUrl}guide | ${workspace}/docs/guide/*.md | ${docsSpace}/src/guide/*.md |
http://127.0.0.1${baseUrl}zh-CN/guide | ${workspace}/docs/guide/*.zh-CN.md${workspace}/docs/guide/*.md | ${docsSpace}/src/zh-CN/guide/*.md |
http://127.0.0.1${baseUrl}advance | ${workspace}/docs/advance/*.md | ${docsSpace}/src/advance/*.md |
http://127.0.0.1${baseUrl}zh-CN/advance | ${workspace}/docs/advance/*.zh-CN.md${workspace}/docs/advance/*.md | ${docsSpace}/src/zh-CN/advance/*.md |
http://127.0.0.1${baseUrl}api | 默认 ${workspace}/docs/.markdowns/*.md | ${docsSpace}/src/api/*.md |
http://127.0.0.1${baseUrl}zh-CN/api | 默认 ${workspace}/docs/.markdowns/*.zh-CN.md默认 ${workspace}/docs/advance/*.md | ${docsSpace}/src/zh-CN/api/*.md |
http://127.0.0.1${baseUrl}changelog | ${workspace}/docs/CHANGELOG.md${workspace}/CHANGELOG.md | ${docsSpace}/src/changelog/README.md |
http://127.0.0.1${baseUrl}zh-CN/changelog | ${workspace}/docs/CHANGELOG.zh-CN.md${workspace}/CHANGELOG.zh-CN.md${workspace}/docs/CHANGELOG.md${workspace}/CHANGELOG.md | ${docsSpace}/src/zh-CN/changelog/README.md |
http://127.0.0.1${baseUrl}todo | ${workspace}/docs/TODOLIST.md${workspace}/TODOLIST.md | ${docsSpace}/src/todo/README.md |
http://127.0.0.1${baseUrl}zh-CN/todo | ${workspace}/docs/TODOLIST.zh-CN.md${workspace}/TODOLIST.zh-CN.md${workspace}/docs/TODOLIST.md${workspace}/TODOLIST.md | ${docsSpace}/src/zh-CN/todo/README.md |
http://127.0.0.1${baseUrl}about | ${workspace}/docs/ABOUT.md | ${docsSpace}/src/about/README.md |
http://127.0.0.1${baseUrl}zh-CN/about | ${workspace}/docs/ABOUT.zh-CN.md${workspace}/docs/ABOUT.md | ${docsSpace}/src/zh-CN/about/README.md |
Rush.js 项目
| 访问地址 | 扫描文件 | 移动后路径 |
|---|---|---|
http://127.0.0.1${baseUrl} | ${workspace}/docs/README.md${workspace}/README.md | ${docsSpace}/src/README.md |
http://127.0.0.1${baseUrl}zh-CN | ${workspace}/docs/README.zh-CN.md${workspace}/README.zh-CN.md${workspace}/docs/README.md${workspace}/README.md | ${docsSpace}/src/zh-CN/README.md |
http://127.0.0.1${baseUrl}overview | ${workspace}/docs/overview/*.md | ${docsSpace}/src/overview/*.md |
http://127.0.0.1${baseUrl}zh-CN/overview | ${workspace}/docs/overview/*.zh-CN.md${workspace}/docs/overview/*.md | ${docsSpace}/src/zh-CN/overview/*.md |
http://127.0.0.1${baseUrl}guide/${unscopedPackageName} | ${workspace}/${projectFolder}/docs/guide/*.md | ${docsSpace}/src/guide/${unscopedPackageName}/*.md |
http://127.0.0.1${baseUrl}zh-CN/guide/${unscopedPackageName} | ${workspace}/${projectFolder}/docs/guide/*.zh-CN.md${workspace}/${projectFolder}/docs/guide/*.md | ${docsSpace}/src/zh-CN/guide/${unscopedPackageName}/*.md |
http://127.0.0.1${baseUrl}advance/${unscopedPackageName} | ${workspace}/${projectFolder}/docs/advance/*.md | ${docsSpace}/src/advance/${unscopedPackageName}/*.md |
http://127.0.0.1${baseUrl}zh-CN/advance/${unscopedPackageName} | ${workspace}/${projectFolder}/docs/advance/*.zh-CN.md${workspace}/${projectFolder}/docs/advance/*.md | ${docsSpace}/src/zh-CN/advance/${unscopedPackageName}/*.md |
http://127.0.0.1${baseUrl}api/${unscopedPackageName} | 默认 ${workspace}/${projectFolder}/docs/.markdowns/*.md | ${docsSpace}/src/api/${unscopedPackageName}/*.md |
http://127.0.0.1${baseUrl}zh-CN/api/${unscopedPackageName} | 默认 ${workspace}/${projectFolder}/docs/.markdowns/*.zh-CN.md默认 ${workspace}/${projectFolder}/docs/advance/*.md | ${docsSpace}/src/zh-CN/api/${unscopedPackageName}/*.md |
http://127.0.0.1${baseUrl}changelog/${unscopedPackageName} | ${workspace}/${projectFolder}/docs/CHANGELOG.md${workspace}/${projectFolder}/CHANGELOG.md | ${docsSpace}/src/changelog/README.md |
http://127.0.0.1${baseUrl}zh-CN/changelog/${unscopedPackageName} | ${workspace}/${projectFolder}/docs/CHANGELOG.zh-CN.md${workspace}/${projectFolder}/CHANGELOG.zh-CN.md${workspace}/${projectFolder}/docs/CHANGELOG.md${workspace}/${projectFolder}/CHANGELOG.md | ${docsSpace}/src/zh-CN/changelog/README.md |
http://127.0.0.1${baseUrl}todo/${unscopedPackageName} | ${workspace}/${projectFolder}/docs/TODOLIST.md${workspace}/${projectFolder}/TODOLIST.md | ${docsSpace}/src/todo/README.md |
http://127.0.0.1${baseUrl}zh-CN/todo/${unscopedPackageName} | ${workspace}/${projectFolder}/docs/TODOLIST.zh-CN.md${workspace}/${projectFolder}/TODOLIST.zh-CN.md${workspace}/${projectFolder}/docs/TODOLIST.md${workspace}/${projectFolder}/TODOLIST.md | ${docsSpace}/src/zh-CN/todo/README.md |
http://127.0.0.1${baseUrl}about | ${workspace}/docs/ABOUT.md | ${docsSpace}/src/about/README.md |
http://127.0.0.1${baseUrl}zh-CN/about | ${workspace}/docs/ABOUT.zh-CN.md${workspace}/docs/ABOUT.md | ${docsSpace}/src/zh-CN/about/README.md |