diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 5685e6b..2dcb63b 100755 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -28,33 +28,57 @@ module.exports = { * ref：https://v1.vuepress.vuejs.org/theme/default-theme-config.html */ themeConfig: { - repo: '', + repo: 'https://github.com/xuos/xuos', editLinks: false, docsDir: '', editLinkText: '', - lastUpdated: false, + lastUpdated: true, nav: [ { - text: 'Guide', - link: '/guide/', + text: '文档', + items: [ + { + text: '简介', + link: '/doc/intro.html', + }, + { + text: '内核', + link: '/doc/kernel.html', + }, + { + text: '驱动', + link: '/doc/driver.html', + }, + { + text: '应用开发', + link: '/doc/appdev.html', + } + ] }, { - text: 'Config', - link: '/config/' + text: '资源', + link: '/resource/', }, { - text: 'VuePress', - link: 'https://v1.vuepress.vuejs.org' - } + text: '社区', + link: '/community/', + }, + { + text: '关于', + link: '/about/', + }, ], sidebar: { - '/guide/': [ + '/doc/': [ { - title: 'Guide', + title: '文档', collapsable: false, children: [ '', - 'using-vue', + 'intro', + 'kernel', + 'appdev', + 'api', ] } ], diff --git a/docs/.vuepress/public/images/hero.png b/docs/.vuepress/public/images/hero.png new file mode 100644 index 0000000..ac6beaf Binary files /dev/null and b/docs/.vuepress/public/images/hero.png differ diff --git a/docs/README.md b/docs/README.md index d90de70..ec1cdc1 100755 --- a/docs/README.md +++ b/docs/README.md @@ -1,16 +1,16 @@ --- home: true -heroImage: https://v1.vuepress.vuejs.org/hero.png -tagline: 面向工业场景，使能智能感联, 助力智能生产 -actionText: 快速上手 → +heroImage: images/hero.png +tagline: 为工业而生，以智能为擎，循标准而行 +actionText: 了解更多 → actionLink: /guide/ features: - title: 实时感知智能识别 - details: 在工业生产等环境下, 通过节点级物联网设备, 实时感知并智能识别图像、声音、环境参数等各类数据, 使其数字化 + details: 节点级物联网设备实时感知并智能识别工业环境下的图像、声音、环境等数据 - title: 灵活组网互联互通 - details: 支持多种低延迟低能耗的无线通信协议, 可在复杂环境中灵活自组织网络, 传输和汇聚工业数据，实现网络化 + details: 支持多种低延迟低能耗的无线通信协议, 在复杂环境中灵活自组网络 - title: 生态友好标准兼容 - details: 兼容POSIX标准，支持主流硬件架构, 对Linux/RISC-V/ARM等生态圈的用户友好, 开发移植门槛低 + details: 兼容POSIX标准，支持主流硬件架构, 对Linux/RISC-V/ARM等生态的用户友好 footer: ©2020 北京大学信息技术高等研究院泛在操作系统实验室 --- diff --git a/docs/about/README.md b/docs/about/README.md new file mode 100644 index 0000000..20728be --- /dev/null +++ b/docs/about/README.md @@ -0,0 +1 @@ +# 关于 diff --git a/docs/about/contact.md b/docs/about/contact.md new file mode 100644 index 0000000..78e7e97 --- /dev/null +++ b/docs/about/contact.md @@ -0,0 +1 @@ +# 联系方式 diff --git a/docs/about/license.md b/docs/about/license.md new file mode 100644 index 0000000..cc3e074 --- /dev/null +++ b/docs/about/license.md @@ -0,0 +1 @@ +# License diff --git a/docs/about/xuos.md b/docs/about/xuos.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/community/README.md b/docs/community/README.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/config/README.md b/docs/config/README.md deleted file mode 100755 index 63a04b9..0000000 --- a/docs/config/README.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -sidebar: auto ---- - -# Config - -## foo - -- Type: `string` -- Default: `/` - -## bar - -- Type: `string` -- Default: `/` diff --git a/docs/doc/README.md b/docs/doc/README.md new file mode 100644 index 0000000..9ffa169 --- /dev/null +++ b/docs/doc/README.md @@ -0,0 +1 @@ +# 文档中心 diff --git a/docs/doc/api.md b/docs/doc/api.md new file mode 100644 index 0000000..5932792 --- /dev/null +++ b/docs/doc/api.md @@ -0,0 +1 @@ +# API diff --git a/docs/doc/appdev.md b/docs/doc/appdev.md new file mode 100644 index 0000000..7d28a52 --- /dev/null +++ b/docs/doc/appdev.md @@ -0,0 +1 @@ +# 应用开发 diff --git a/docs/doc/driver.md b/docs/doc/driver.md new file mode 100644 index 0000000..dd94d13 --- /dev/null +++ b/docs/doc/driver.md @@ -0,0 +1 @@ +# 驱动 diff --git a/docs/doc/intro.md b/docs/doc/intro.md new file mode 100644 index 0000000..b6d4af6 --- /dev/null +++ b/docs/doc/intro.md @@ -0,0 +1 @@ +# 简介 diff --git a/docs/doc/kernel.md b/docs/doc/kernel.md new file mode 100644 index 0000000..3658edf --- /dev/null +++ b/docs/doc/kernel.md @@ -0,0 +1 @@ +# 内核 diff --git a/docs/guide/README.md b/docs/guide/README.md deleted file mode 100755 index fc82aec..0000000 --- a/docs/guide/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Introduction - -VuePress is composed of two parts: a [minimalistic static site generator](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/core) with a Vue-powered [theming system](https://v1.vuepress.vuejs.org/theme/) and [Plugin API](https://v1.vuepress.vuejs.org/plugin/), and a [default theme](https://v1.vuepress.vuejs.org/theme/default-theme-config.html) optimized for writing technical documentation. It was created to support the documentation needs of Vue's own sub projects. - -Each page generated by VuePress has its own pre-rendered static HTML, providing great loading performance and is SEO-friendly. Once the page is loaded, however, Vue takes over the static content and turns it into a full Single-Page Application (SPA). Additional pages are fetched on demand as the user navigates around the site. diff --git a/docs/guide/using-vue.md b/docs/guide/using-vue.md deleted file mode 100755 index 71ac45b..0000000 --- a/docs/guide/using-vue.md +++ /dev/null @@ -1,9 +0,0 @@ -# Using Vue in Markdown - -## Browser API Access Restrictions - -Because VuePress applications are server-rendered in Node.js when generating static builds, any Vue usage must conform to the [universal code requirements](https://ssr.vuejs.org/en/universal.html). In short, make sure to only access Browser / DOM APIs in `beforeMount` or `mounted` hooks. - -If you are using or demoing components that are not SSR friendly (for example containing custom directives), you can wrap them inside the built-in `` component: - -## diff --git a/docs/resource/README.md b/docs/resource/README.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/resource/download.md b/docs/resource/download.md new file mode 100644 index 0000000..e69de29 diff --git a/package.json b/package.json index c3d5f60..2a89f1a 100644 --- a/package.json +++ b/package.json @@ -4,15 +4,15 @@ "description": "使能智能化制造, 促进人机物融合", "main": "index.js", "authors": { - "name": "", - "email": "" + "name": "XUOS Lab", + "email": "caodg@pku.edu.cn" }, - "repository": "", + "repository": "https://github.com/xuos/xuos-web", "scripts": { "dev": "vuepress dev docs", "build": "vuepress build docs" }, - "license": "MIT", + "license": "Mulan", "devDependencies": { "vuepress": "^1.3.1", "@vuepress/plugin-back-to-top": "^1.3.1",