From da7d285f6b310eea817c9c93a62976809e0d529c Mon Sep 17 00:00:00 2001 From: hhhkkk520 Date: Thu, 19 May 2022 11:24:32 +0200 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E6=96=87=E6=A1=A3=E7=BB=93?= =?UTF-8?q?=E6=9E=84=EF=BC=8C=E5=A2=9E=E5=8A=A0=E5=BC=80=E5=8F=91=E6=89=8B?= =?UTF-8?q?=E5=86=8C=E5=8C=BA=E5=9F=9F=EF=BC=8C=E6=96=B0=E5=A2=9EAPI?= =?UTF-8?q?=E3=80=81=E4=B8=BB=E9=A2=98=E5=BC=80=E5=8F=91=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.ts | 30 +++++-------- docs/developer/algolia-search.md | 53 ----------------------- docs/developer/basics.md | 59 -------------------------- docs/developer/carbon-ads.md | 15 ------- docs/developer/homepage.md | 23 ---------- docs/developer/index.md | 10 +++++ docs/developer/theme.md | 1 + docs/en_US/developer/algolia-search.md | 1 - docs/en_US/developer/basics.md | 1 - docs/en_US/developer/carbon-ads.md | 1 - docs/en_US/developer/homepage.md | 1 - docs/en_US/developer/index.md | 10 +++++ docs/en_US/developer/theme.md | 1 + docs/en_US/guide/api.md | 1 + docs/en_US/index.md | 2 +- docs/guide/api.md | 1 + package-lock.json | 6 --- 17 files changed, 35 insertions(+), 181 deletions(-) delete mode 100644 docs/developer/algolia-search.md delete mode 100644 docs/developer/basics.md delete mode 100644 docs/developer/carbon-ads.md delete mode 100644 docs/developer/homepage.md create mode 100644 docs/developer/index.md create mode 100644 docs/developer/theme.md delete mode 100644 docs/en_US/developer/algolia-search.md delete mode 100644 docs/en_US/developer/basics.md delete mode 100644 docs/en_US/developer/carbon-ads.md delete mode 100644 docs/en_US/developer/homepage.md create mode 100644 docs/en_US/developer/index.md create mode 100644 docs/en_US/developer/theme.md create mode 100644 docs/en_US/guide/api.md create mode 100644 docs/guide/api.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 5f01629c..bb13ae41 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -25,7 +25,7 @@ export default defineConfig({ }, { text: '开发手册', - link: '/developer/basics', + link: '/developer/index', activeMatch: '^/developer/' } ], @@ -46,7 +46,7 @@ export default defineConfig({ label: 'English', nav: [ { text: 'User Guide', link: '/en_US/', activeMatch: '^/$|^/en_US/guide/' }, - { text: 'Development Manual', link: '/en_US/developer/basics', activeMatch: '^/en_US/developer/' } + { text: 'Development Manual', link: '/en_US/developer/index', activeMatch: '^/en_US/developer/' } ], sidebar: { @@ -81,7 +81,8 @@ function getGuideSidebarZhCN() { { text: '服务', link: '/guide/services' }, { text: '定时任务', link: '/guide/tasks' }, { text: '报警通知', link: '/guide/notifications' }, - { text: '设置', link: '/guide/settings' } + { text: '设置', link: '/guide/settings' }, + { text: 'API', link: '/guide/api' } ] }, { @@ -101,15 +102,9 @@ function getGuideSidebarZhCN() { function getDeveloperSidebarZhCN() { return [ { - text: 'App Config', - children: [ { text: 'Basics', link: '/developer/basics' } ] - }, - { - text: 'Theme Config', + text: '开发手册', children: [ - { text: 'Homepage', link: '/developer/homepage' }, - { text: 'Algolia Search', link: '/developer/algolia-search' }, - { text: 'Carbon Ads', link: '/developer/carbon-ads' } + { text: '创建新主题', link: '/developer/theme' } ] } ] @@ -131,7 +126,8 @@ function getGuideSidebarEnUS() { { text: 'Services', link: '/en_US/guide/services' }, { text: 'Tasks', link: '/en_US/guide/tasks' }, { text: 'Notifications', link: '/en_US/guide/notifications' }, - { text: 'Settings', link: '/en_US/guide/settings' } + { text: 'Settings', link: '/en_US/guide/settings' }, + { text: 'API', link: '/en_US/guide/api' } ] }, { @@ -149,15 +145,9 @@ function getGuideSidebarEnUS() { function getDeveloperSidebarEnUS() { return [ { - text: 'App Config', - children: [ { text: 'Basics', link: '/en_US/developer/basics' } ] - }, - { - text: 'Theme Config', + text: 'Development Manual', children: [ - { text: 'Homepage', link: '/en_US/developer/homepage' }, - { text: 'Algolia Search', link: '/en_US/developer/algolia-search' }, - { text: 'Carbon Ads', link: '/en_US/developer/carbon-ads' } + { text: 'Create a new theme', link: '/en_US/developer/theme' } ] } ] diff --git a/docs/developer/algolia-search.md b/docs/developer/algolia-search.md deleted file mode 100644 index 132b0a56..00000000 --- a/docs/developer/algolia-search.md +++ /dev/null @@ -1,53 +0,0 @@ -# Theme Config: Algolia Search - -The `themeConfig.algolia` option allows you to use [Algolia DocSearch](https://docsearch.algolia.com). To enable it, you need to provide at least appId, apiKey and indexName: - -```js -module.exports = { - themeConfig: { - algolia: { - appId: 'your_app_id', - apiKey: 'your_api_key', - indexName: 'index_name' - } - } -} -``` - -For more options, check out [Algolia DocSearch's documentation](https://docsearch.algolia.com/docs/api/). You can pass any extra option alongside other options, e.g. passing `searchParameters`: - -```js -module.exports = { - themeConfig: { - algolia: { - appId: 'your_app_id', - apiKey: 'your_api_key', - indexName: 'index_name', - searchParameters: { - facetFilters: ['tags:guide,api'] - } - } - } -} -``` - -## Internationalization (i18n) - -If you have multiple locales in your documentation and you have defined a `locales` object in your `themeConfig`: - -```js -module.exports = { - themeConfig: { - locales: { - // ... - }, - algolia: { - appId: 'your_app_id', - apiKey: 'your_api_key', - indexName: 'index_name' - } - } -} -``` - -VitePress will automatically add a `lang` _facetFilter_ to the `searchParameters.facetFilter` array with the correct language value. Algolia automatically adds the correct facet filter based on the `lang` attribute on the `` tag. This will match search results with the currently viewed language of the page. diff --git a/docs/developer/basics.md b/docs/developer/basics.md deleted file mode 100644 index 5955ecb5..00000000 --- a/docs/developer/basics.md +++ /dev/null @@ -1,59 +0,0 @@ -# App Config: Basics - -::: tip -The config reference is incomplete since the config format may still receive further changes. For a complete reference of the current available options, refer to [config.ts](https://github.com/vuejs/vitepress/blob/45b65ce8b63bd54f345bfc3383eb2416b6769dc9/src/node/config.ts#L30-L65). -::: - -## base - -- Type: `string` -- Default: `/` - -The base URL the site will be deployed at. You will need to set this if you plan to deploy your site under a sub path, for example, GitHub pages. If you plan to deploy your site to `https://foo.github.io/bar/`, then you should set base to `'/bar/'`. It should always start and end with a slash. - -The `base` is automatically prepended to all the URLs that start with `/` in other options, so you only need to specify it once. - -```js -module.exports = { - base: '/base/' -} -``` - -## lang - -- Type: `string` -- Default: `en-US` - -The `lang` attribute for the site. This will render as a `` tag in the page HTML. - -```js -module.exports = { - lang: 'en-US' -} -``` - -## title - -- Type: `string` -- Default: `VitePress` - -Title for the site. This will be the suffix for all page titles, and displayed in the navbar. - -```js -module.exports = { - title: 'VitePress' -} -``` - -## description - -- Type: `string` -- Default: `A VitePress site` - -Description for the site. This will render as a `` tag in the page HTML. - -```js -module.exports = { - description: 'A VitePress site' -} -``` diff --git a/docs/developer/carbon-ads.md b/docs/developer/carbon-ads.md deleted file mode 100644 index 3bb074d1..00000000 --- a/docs/developer/carbon-ads.md +++ /dev/null @@ -1,15 +0,0 @@ -# Theme Config: Carbon Ads - -VitePress has built in native support for [Carbon Ads](https://www.carbonads.net). By defining the Carbon Ads credentials in config, VitePress will display ads on the page. - -```js -module.exports = { - themeConfig: { - carbonAds: { - carbon: 'your-carbon-key', - custom: 'your-carbon-custom', - placement: 'your-carbon-placement' - } - } -} -``` diff --git a/docs/developer/homepage.md b/docs/developer/homepage.md deleted file mode 100644 index 4e548f86..00000000 --- a/docs/developer/homepage.md +++ /dev/null @@ -1,23 +0,0 @@ -# Theme Config: Homepage - -VitePress provides a homepage layout. To use it, specify `home: true` plus some other metadata in your root `index.md`'s YAML frontmatter. This is an example of how it works: - -```yaml ---- -home: true -heroImage: /logo.png -heroAlt: Logo image -heroText: Hero Title -tagline: Hero subtitle -actionText: Get Started -actionLink: /guide/ -features: - - title: Simplicity First - details: Minimal setup with markdown-centered project structure helps you focus on writing. - - title: Vue-Powered - details: Enjoy the dev experience of Vue + webpack, use Vue components in markdown, and develop custom themes with Vue. - - title: Performant - details: VitePress generates pre-rendered static HTML for each page, and runs as an SPA once a page is loaded. -footer: MIT Licensed | Copyright © 2019-present Evan You ---- -``` diff --git a/docs/developer/index.md b/docs/developer/index.md new file mode 100644 index 00000000..8328cced --- /dev/null +++ b/docs/developer/index.md @@ -0,0 +1,10 @@ +--- +home: true +heroImage: https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg +heroText: 开发手册 +tagline: 欢迎使用哪吒监控开发手册，我们欢迎你提出高质量的Pull Request，帮助哪吒监控变得更好！ +actionText: 开始使用 → +actionLink: /developer/theme +footer: Copyright © 2022-present Nezhahq +--- +
本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。 \ No newline at end of file diff --git a/docs/developer/theme.md b/docs/developer/theme.md new file mode 100644 index 00000000..92ec2786 --- /dev/null +++ b/docs/developer/theme.md @@ -0,0 +1 @@ +敬请期待 \ No newline at end of file diff --git a/docs/en_US/developer/algolia-search.md b/docs/en_US/developer/algolia-search.md deleted file mode 100644 index c7035b8c..00000000 --- a/docs/en_US/developer/algolia-search.md +++ /dev/null @@ -1 +0,0 @@ -# Theme Config: Algolia Search \ No newline at end of file diff --git a/docs/en_US/developer/basics.md b/docs/en_US/developer/basics.md deleted file mode 100644 index c2ced44a..00000000 --- a/docs/en_US/developer/basics.md +++ /dev/null @@ -1 +0,0 @@ -# App Config: Basics \ No newline at end of file diff --git a/docs/en_US/developer/carbon-ads.md b/docs/en_US/developer/carbon-ads.md deleted file mode 100644 index 1d7edbdb..00000000 --- a/docs/en_US/developer/carbon-ads.md +++ /dev/null @@ -1 +0,0 @@ -# Theme Config: Carbon Ads \ No newline at end of file diff --git a/docs/en_US/developer/homepage.md b/docs/en_US/developer/homepage.md deleted file mode 100644 index 7cba25be..00000000 --- a/docs/en_US/developer/homepage.md +++ /dev/null @@ -1 +0,0 @@ -# Theme Config: Homepage \ No newline at end of file diff --git a/docs/en_US/developer/index.md b/docs/en_US/developer/index.md new file mode 100644 index 00000000..49ce22d3 --- /dev/null +++ b/docs/en_US/developer/index.md @@ -0,0 +1,10 @@ +--- +home: true +heroImage: https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg +heroText: Development Manual +tagline: Welcome to the Nezha Monitoring Development Manual. +actionText: Start Now → +actionLink: /en_US/developer/theme +footer: Copyright © 2022-present Nezhahq +--- +
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. diff --git a/docs/en_US/developer/theme.md b/docs/en_US/developer/theme.md new file mode 100644 index 00000000..15cd6ef0 --- /dev/null +++ b/docs/en_US/developer/theme.md @@ -0,0 +1 @@ +Comming soon \ No newline at end of file diff --git a/docs/en_US/guide/api.md b/docs/en_US/guide/api.md new file mode 100644 index 00000000..15cd6ef0 --- /dev/null +++ b/docs/en_US/guide/api.md @@ -0,0 +1 @@ +Comming soon \ No newline at end of file diff --git a/docs/en_US/index.md b/docs/en_US/index.md index a89eb7de..f02bc27b 100644 --- a/docs/en_US/index.md +++ b/docs/en_US/index.md @@ -3,7 +3,7 @@ home: true heroImage: https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg heroText: Nezha Monitoring tagline: A open source, lightweight server and website monitoring and O&M tool -actionText: Learn more → +actionText: Learn More → actionLink: /en_US/guide/dashboard features: - title: One-Click Installation diff --git a/docs/guide/api.md b/docs/guide/api.md new file mode 100644 index 00000000..72069ab6 --- /dev/null +++ b/docs/guide/api.md @@ -0,0 +1 @@ +敬请期待 \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index cc50c5c8..e9e0b0cb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1841,12 +1841,6 @@ "vue": "^3.2.33" } }, - "vitepress-dark-theme": { - "version": "git+ssh://git@github.com/nezhahq/vitepress-dark-theme.git#52550f5807214d139b7219a72b66b0bd9031b078", - "dev": true, - "from": "vitepress-dark-theme@github:nezhahq/vitepress-dark-theme", - "requires": {} - }, "vue": { "version": "3.2.33", "resolved": "https://registry.npmjs.org/vue/-/vue-3.2.33.tgz",