You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
docs/docusaurus.config.js

302 lines
8.5 KiB

const darkCodeTheme = require("prism-react-renderer/themes/palenight");
const math = require("remark-math");
const katex = require("rehype-katex");
const mermaid = require("mdx-mermaid");
const VersionsArchived = require("./versionsArchived.json");
/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Halo Documents",
tagline: "Halo 博客系统的文档站点",
url: "https://docs.halo.run",
baseUrl: "/",
onBrokenLinks: "warn",
onBrokenMarkdownLinks: "warn",
favicon: "img/favicon-96x96.png",
i18n: {
defaultLocale: "zh-Hans",
locales: ["zh-Hans"],
},
organizationName: "halo-dev", // Usually your GitHub org/user name.
projectName: "halo", // Usually your repo name.
presets: [
[
"classic",
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: require.resolve("./sidebars.js"),
// Please change this to your repo.
editUrl: "https://github.com/halo-dev/docs/edit/main/",
routeBasePath: "/",
showLastUpdateTime: true,
showLastUpdateAuthor: true,
remarkPlugins: [math, mermaid],
rehypePlugins: [katex],
lastVersion: "2.0",
versions: {
current: {
label: "2.1.0-SNAPSHOT",
path: "2.1.0-SNAPSHOT",
},
},
},
blog: false,
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
sitemap: {
changefreq: "weekly",
priority: 0.5,
},
googleAnalytics: {
trackingID: "UA-110780416-7",
},
gtag: {
trackingID: "UA-110780416-7",
},
}),
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
docs: {
sidebar: {
autoCollapseCategories: true,
},
},
navbar: {
title: "Halo Documents",
logo: {
alt: "Halo Logo",
src: "https://halo.run/upload/2021/03/Adaptive256-463ca9b92e2d40268431018c07735842.png",
},
items: [
{
href: "https://halo.run",
label: "官网",
},
{
href: "https://bbs.halo.run",
label: "论坛",
},
{
type: "docsVersionDropdown",
position: "right",
dropdownActiveClassDisabled: true,
dropdownItemsAfter: [
...Object.entries(VersionsArchived).map(
([versionName, versionUrl]) => ({
label: versionName,
href: versionUrl,
})
),
{
to: "/versions",
label: "All versions",
},
],
},
{
href: "https://github.com/halo-dev/halo",
label: "GitHub",
position: "right",
},
{
href: "https://gitee.com/halo-dev/halo",
label: "Gitee",
position: "right",
},
],
},
footer: {
style: "dark",
copyright: `Copyright © 2022 <a target="_blank" href="https://www.fit2cloud.com/">FIT2CLOUD 飞致云</a>. 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: "微信群申请",
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,
darkTheme: darkCodeTheme,
},
algolia: {
apiKey: "739f2a55c6d13d93af146c22a4885669",
indexName: "docs",
contextualSearch: true,
appId: "OG53LY1OQH",
},
}),
plugins: [
[
"@docusaurus/plugin-client-redirects",
{
redirects: [
{
to: "/1.6/getting-started/install/linux",
from: [
"/zh/install",
"/install",
"/zh/install/index",
"/install/index",
"/zh/install/linux",
"/install/linux",
],
},
{
to: "/getting-started/install/docker",
from: ["/zh/install/docker", "/install/docker"],
},
{
to: "/1.6/getting-started/install/other/bt-panel",
from: ["/zh/install/bt-panel", "/install/bt-panel"],
},
{
to: "/getting-started/install/other/oneinstack",
from: ["/zh/install/oneinstack", "/install/oneinstack"],
},
{
to: "/1.6/getting-started/install/other/tencent-cloudbase",
from: [
"/zh/install/tencent-cloudbase",
"/install/tencent-cloudbase",
],
},
{
to: "/getting-started/prepare",
from: ["/zh/install/prepare", "/install/prepare"],
},
{
to: "/getting-started/config",
from: ["/zh/install/config", "/install/config"],
},
{
to: "/1.6/getting-started/upgrade",
from: ["/zh/install/upgrade", "/install/upgrade"],
},
{
to: "/getting-started/downloads",
from: ["/zh/install/downloads", "/install/downloads"],
},
{
to: "/user-guide/backup-migration",
from: ["/zh/user-guide/backup-migration"],
},
{
to: "/user-guide/markdown",
from: ["/zh/user-guide/markdown"],
},
{
to: "/developer-guide/core/structure",
from: ["/zh/developer-guide/core", "/developer-guide/core"],
},
{
to: "/developer-guide/theme/prepare",
from: ["/zh/developer-guide/theme", "/developer-guide/theme"],
},
{
to: "/contribution/issue",
from: ["/zh/contribution/issue"],
},
{
to: "/contribution/pr",
from: ["/zh/contribution/pr"],
},
],
createRedirects(existingPath) {
if (existingPath.startsWith("/1.5/")) {
return [
existingPath.replace("/1.5/", "/1.5.4/"),
existingPath.replace("/1.5/", "/1.5.3/"),
existingPath.replace("/1.5/", "/1.5.2/"),
existingPath.replace("/1.5/", "/1.5.1/"),
existingPath.replace("/1.5/", "/1.5.0/"),
];
}
if (existingPath.startsWith("/1.4/")) {
return [existingPath.replace("/1.4/", "/1.4.17/")];
}
if (existingPath.startsWith("/2.1.0-SNAPSHOT/")) {
return [
existingPath.replace("/2.1.0-SNAPSHOT/", "/2.0.0-SNAPSHOT/"),
];
}
return undefined;
},
},
],
],
scripts: [
{
src: "https://analytics.halo.run/umami.js",
async: true,
defer: true,
"data-website-id": "7e8d48ad-973d-4b44-b36d-ea1f1df25baa",
},
],
stylesheets: [
{
href: "https://unpkg.com/katex@0.12.0/dist/katex.min.css",
type: "text/css",
},
],
};
module.exports = config;