Scan Rule
About 4 min
Scan Rule
Here we explain which paths @hz-9/docs-build will scan in order to generate documentation.
In the Scan path column, when there are multiple files, they are matched in the order from top to bottom.
${baseUrl} is equivalent to the --base-url parameter. The default value is / and should be passed in the format /tool/.
${workspace} is equivalent to process.cwd() or the --root parameter.
${docsSpace} is usually the ${workspace}/docs/.vuepress path, which is automatically created and added to .gitignore.
${projectFolder} is the relative path within a Rush.js project.
${unscopedPackageName} is considered as the package name without the scope.
Normal Project
| Url | Scan path | Moved path |
|---|---|---|
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 |
In Rush.js Project
| 访问地址 | 扫描文件 | 移动后路径 |
|---|---|---|
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} | Default ${workspace}/${projectFolder}/docs/.markdowns/*.md | ${docsSpace}/src/api/${unscopedPackageName}/*.md |
http://127.0.0.1${baseUrl}zh-CN/api/${unscopedPackageName} | Default ${workspace}/${projectFolder}/docs/.markdowns/*.zh-CN.mdDefault ${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 |