-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
feat: Generate sidebar and nav by version and language
玲珑文档需要保留多语言以及多版本的文档内容，对 sidebar 进行改造 Log: Generate sidebar
1 parent
36f2e76
commit 325dce6
Showing
5 changed files
with
200 additions
and
202 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| const { versions } = require('./versions.js') | ||
|
|
||
| // 定义每个类别及其子项的映射 | ||
| const categoryMappings = { | ||
| "zh": { | ||
| "item": "版本", | ||
| "defaultVersion": "主分支", | ||
| "link": "/start/install.md" | ||
| }, | ||
| "en": { | ||
| "item": "Version", | ||
| "defaultVersion": "master", | ||
| "link": "/start/install.md" | ||
| } | ||
| } | ||
|
|
||
| // 函数来生成特定语言和版本的导航栏 | ||
| function generateNav(language) { | ||
| lst = []; | ||
| const items = []; | ||
| // 检测 md 文件是否存在。 | ||
| versions.forEach(version => { | ||
| const versionPrefix = version ? `${version}/` : ''; | ||
| const pathPrefix = language === 'zh' | ||
| ? `/${versionPrefix}guide` | ||
| : `/${versionPrefix}${language}/guide`; | ||
| const defaultVersion = version ? `${version}` : categoryMappings[language]['defaultVersion']; | ||
| items.push({ | ||
| text: defaultVersion, | ||
| link: `${pathPrefix}${categoryMappings[language]['link']}` | ||
| }); | ||
| }); | ||
|
|
||
| lst.push({ | ||
| text: categoryMappings[language]['item'], | ||
| ariaLabel: "Version Menu", | ||
| items: items | ||
| }); | ||
| return lst; | ||
| } | ||
|
|
||
| module.exports = { generateNav }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| const fs = require('fs'); | ||
| const path = require('path'); | ||
|
|
||
| const { versions } = require('./versions.js') | ||
| const langs = ['zh', 'en'] | ||
|
|
||
| // 所有版本和语言的指南结构 | ||
| let sidebar = {}; | ||
|
|
||
| // 定义每个类别及其子项的映射 | ||
| const categoryMappings = { | ||
| "zh": { | ||
| "开始": { | ||
| "安装": "/start/install.md", | ||
| }, | ||
| "命令行工具": { | ||
| "简介": "/ll-cli/introduction.md", | ||
| "列出已安装的应用": "/ll-cli/list.md", | ||
| "从远程仓库查询应用": "/ll-cli/query.md", | ||
| "安装应用": "/ll-cli/install.md", | ||
| "运行应用": "/ll-cli/run.md", | ||
| "卸载应用": "/ll-cli/uninstall.md", | ||
| "更新应用": "/ll-cli/update.md", | ||
| "查看运行中的应用": "/ll-cli/ps.md", | ||
| "进入容器内部": "/ll-cli/exec.md", | ||
| "强制退出应用": "/ll-cli/kill.md" | ||
| }, | ||
| "构建工具": { | ||
| "简介": "/ll-builder/introduction.md", | ||
| "创建项目": "/ll-builder/create.md", | ||
| "构建应用": "/ll-builder/build.md", | ||
| "运行应用": "/ll-builder/run.md", | ||
| "导出uab格式应用": "/ll-builder/export.md", | ||
| "配置文件": "/ll-builder/manifests.md", | ||
| "上架应用到商店": "/ll-builder/github.md" | ||
| }, | ||
| "调试应用": { | ||
| "IDE中调试应用": "/debug/debug.md", | ||
| "常见构建问题": "/debug/ll-builder-faq.md", | ||
| "常见运行问题": "/debug/faq.md" | ||
| } | ||
| }, | ||
| "en": { | ||
| "Getting Started": { | ||
| "Install Linglong Environment": "/start/install.md", | ||
| }, | ||
| "Command Line Tools": { | ||
| "Introduction": "/ll-cli/introduction.md", | ||
| "List Installed Apps": "/ll-cli/list.md", | ||
| "Query Apps From Remote": "/ll-cli/query.md", | ||
| "Install App": "/ll-cli/install.md", | ||
| "Run App": "/ll-cli/run.md", | ||
| "Uninstall App": "/ll-cli/uninstall.md", | ||
| "Update App": "/ll-cli/update.md", | ||
| "View Running Apps": "/ll-cli/ps.md", | ||
| "Attach To Container": "/ll-cli/exec.md", | ||
| "Force Quit App": "/ll-cli/kill.md", | ||
| }, | ||
| "Build Tools": { | ||
| "Introduction": "/ll-builder/introduction.md", | ||
| "Create Project": "/ll-builder/create.md", | ||
| "Build App": "/ll-builder/build.md", | ||
| "Run Compiled App": "/ll-builder/run.md", | ||
| "Export Uab Format": "/ll-builder/export.md", | ||
| "Manifests": "/ll-builder/manifests.md", | ||
| "App To Store": "/ll-builder/github.md" | ||
| }, | ||
| "Debug App": { | ||
| "Debug App In IDE": "/debug/debug.md", | ||
| "Build FAQ": "/debug/ll-builder-faq.md", | ||
| "Run FAQ": "/debug/faq.md" | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| // 函数来生成特定语言和版本的指南结构 | ||
| function generateSideba(pathPrefix, language) { | ||
| lst = []; | ||
|
|
||
| for (const category in categoryMappings[language]) { | ||
| const items = []; | ||
| Object.entries(categoryMappings[language][category]).forEach(([itemName, link]) => { | ||
| // 检测 md 文件是否存在。 | ||
| const fullFilePath = path.join(path.dirname(path.dirname(__dirname)), `${pathPrefix}${link}`); | ||
| if (fs.existsSync(fullFilePath)) { | ||
| items.push({ | ||
| text: itemName, | ||
| link: `${pathPrefix}${link}` | ||
| }); | ||
| } | ||
| }); | ||
|
|
||
| lst.push({ | ||
| collapsible: true, | ||
| text: category, | ||
| items: items | ||
| }); | ||
| } | ||
| return lst; | ||
| } | ||
|
|
||
|
|
||
| versions.forEach(version => { | ||
| langs.forEach(language => { | ||
| const versionPrefix = version ? `${version}/` : ''; | ||
| const pathPrefix = language === 'zh' | ||
| ? `/${versionPrefix}guide` | ||
| : `/${versionPrefix}${language}/guide`; | ||
|
|
||
| sidebar[pathPrefix] = generateSideba(pathPrefix, language); | ||
| }); | ||
|
|
||
| }); | ||
|
|
||
| exports.sidebar = sidebar |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| const versions = ['']; | ||
| exports.versions = versions; |