From b43c1d3301574f3114cd84ee8b5e0ece736bb4db Mon Sep 17 00:00:00 2001 From: Ryan Wang Date: Fri, 8 Oct 2021 20:02:24 +0800 Subject: [PATCH] feat: add footer links --- docs/about.md | 16 +++++++++ docusaurus.config.js | 59 +++++++++++++++++++++++++++++++ sidebars.js | 84 ++++++++++++++++++++------------------------ src/css/custom.css | 4 +++ 4 files changed, 118 insertions(+), 45 deletions(-) create mode 100644 docs/about.md diff --git a/docs/about.md b/docs/about.md new file mode 100644 index 0000000..9ea2465 --- /dev/null +++ b/docs/about.md @@ -0,0 +1,16 @@ +--- +title: 关于文档 +description: 关于本文档站点的一些说明 +--- + +:::note +此文档使用 [Docusaurus](https://docusaurus.io/) 搭建，感谢 [Docusaurus](https://github.com/facebook/docusaurus) 社区所做的贡献。 +::: + +## 参与贡献 + +:::tip +如果你发现文档中有不正确或者需要添加的内容，非常欢迎参与到文档编辑当中。 +::: + +当前文档的仓库地址为 [halo-dev/docs.halo.run](https://github.com/halo-dev/docs.halo.run) ，所以你可以 fork 此仓库，修改之后提交 `Pull request` 等待我们合并即可。 \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index c291fcc..2e31409 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -78,6 +78,62 @@ const darkCodeTheme = require("prism-react-renderer/themes/dracula"); footer: { style: "dark", copyright: `Copyright © ${new Date().getFullYear()} halo-dev, Inc. Built with Docusaurus.`, + links: [ + { + title: "关于", + items: [ + { + label: "官网", + href: "https://halo.run", + }, + { + label: "主题仓库", + href: "https://halo.run/themes.html", + }, + { + label: "GitHub 组织", + href: "https://github.com/halo-dev", + }, + { + label: 'Gitee 组织', + href: "https://gitee.com/halo-dev", + }, + { + label: 'Server Status', + href: "https://status.halo.run", + } + ], + }, + { + title: "社区", + items: [ + { + label: "官方论坛", + href: "https://bbs.halo.run", + }, + { + label: "微信公众号", + href: "https://halo.run/upload/2021/03/B3C27F16-4890-4633-81CC-20BA4B28F94F-2415126255c749b290312ca22d9bdeb0.jpeg", + }, + { + label: "微信 & QQ群申请", + href: "https://wj.qq.com/s2/8434455/9170/", + }, + { + label: "GitHub Issues", + href: "https://github.com/halo-dev/halo/issues", + }, + { + label: "Telegram Channel", + href: "https://t.me/halo_dev", + }, + { + label: "Telegram Group", + href: "https://t.me/HaloBlog", + }, + ], + }, + ], }, prism: { theme: darkCodeTheme, @@ -86,6 +142,9 @@ const darkCodeTheme = require("prism-react-renderer/themes/dracula"); googleAnalytics: { trackingID: "UA-110780416-7", }, + gtag: { + trackingID: "UA-110780416-7", + }, algolia: { apiKey: "YOUR_API_KEY", indexName: "YOUR_INDEX_NAME", diff --git a/sidebars.js b/sidebars.js index 69a3df1..51d5f7a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -9,7 +9,7 @@ Create as many sidebars as you want. */ -module.exports = { + module.exports = { // By default, Docusaurus generates a sidebar from the docs folder structure // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], @@ -25,78 +25,72 @@ module.exports = { type: "category", label: "安装指南", items: [ - 'getting-started/install/linux', - 'getting-started/install/docker', + "getting-started/install/linux", + "getting-started/install/docker", { - type: 'category', - label: '其他指南', + type: "category", + label: "其他指南", items: [ - 'getting-started/install/other/bt-panel', - 'getting-started/install/other/oneinstack', - 'getting-started/install/other/tencent-cloudbase', + "getting-started/install/other/bt-panel", + "getting-started/install/other/oneinstack", + "getting-started/install/other/tencent-cloudbase", { - type: 'link', - label: '腾讯云开发者实验室', - href: 'https://cloud.tencent.com/developer/labs/lab/10523' - } - ] + type: "link", + label: "腾讯云开发者实验室", + href: "https://cloud.tencent.com/developer/labs/lab/10523", + }, + ], }, - 'getting-started/install/third-party', + "getting-started/install/third-party", ], }, - 'getting-started/config', - 'getting-started/upgrade', - 'getting-started/downloads', + "getting-started/config", + "getting-started/upgrade", + "getting-started/downloads", ], }, { type: "category", label: "用户指南", - items: [ - 'user-guide/backup-migration', - 'user-guide/markdown', - ], + items: ["user-guide/backup-migration", "user-guide/markdown"], }, { type: "category", label: "开发者指南", items: [ { - type: 'category', - label: '系统开发', + type: "category", + label: "系统开发", items: [ - 'developer-guide/core/structure', - 'developer-guide/core/prepare', - 'developer-guide/core/code-style', - ] + "developer-guide/core/structure", + "developer-guide/core/prepare", + "developer-guide/core/code-style", + ], }, { - type: 'category', - label: '主题开发', + type: "category", + label: "主题开发", items: [ - 'developer-guide/theme/prepare', - 'developer-guide/theme/config-files', - 'developer-guide/theme/global-variable', - 'developer-guide/theme/public-template-tag', - 'developer-guide/theme/page-variable', - 'developer-guide/theme/template-tag', - ] + "developer-guide/theme/prepare", + "developer-guide/theme/config-files", + "developer-guide/theme/global-variable", + "developer-guide/theme/public-template-tag", + "developer-guide/theme/page-variable", + "developer-guide/theme/template-tag", + ], }, { - type: 'link', - label: 'REST API', - href: 'https://api.halo.run' - } + type: "link", + label: "REST API", + href: "https://api.halo.run", + }, ], }, { type: "category", label: "参与贡献", - items: [ - 'contribution/issue', - 'contribution/pr', - 'contribution/sponsor', - ], + items: ["contribution/issue", "contribution/pr", "contribution/sponsor"], }, + "about", ], }; diff --git a/src/css/custom.css b/src/css/custom.css index 6abe148..b335b0d 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -16,6 +16,10 @@ --ifm-code-font-size: 95%; } +.markdown h1:first-child { + --ifm-h1-font-size: 2.3rem; +} + .docusaurus-highlight-code-line { background-color: rgba(0, 0, 0, 0.1); display: block;