Files
docs/docusaurus.config.js
Ryan Wang 7e097c93f9 chore: refine plugin development documentation (#503)
* chore: refine plugin development documentation

Signed-off-by: Ryan Wang <i@ryanc.cc>

* chore: refine plugin development documentation

Signed-off-by: Ryan Wang <i@ryanc.cc>

* chore: refine plugin development documentation

Signed-off-by: Ryan Wang <i@ryanc.cc>

---------

Signed-off-by: Ryan Wang <i@ryanc.cc>
2025-06-21 20:47:16 +08:00

222 lines
5.8 KiB
JavaScript

const VersionsArchived = require("./versionsArchived.json");
const { themes } = require("prism-react-renderer");
const darkCodeTheme = themes.palenight;
/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Halo 文档",
tagline: "Halo 的文档站点",
url: "https://docs.halo.run",
baseUrl: "/",
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.
markdown: {
mermaid: true,
},
themes: ["@docusaurus/theme-mermaid"],
future: {
experimental_faster: true,
v4: true,
},
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,
lastVersion: "2.21",
versions: {
current: {
label: "next",
path: "next",
},
},
},
blog: false,
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
sitemap: {
changefreq: "weekly",
priority: 0.5,
ignorePatterns: [
"/2.16/**",
"/2.17/**",
"/2.18/**",
"/2.19/**",
"/2.20/**",
],
},
googleAnalytics: {
trackingID: "UA-110780416-7",
},
gtag: {
trackingID: "UA-110780416-7",
},
}),
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
docs: {
sidebar: {
autoCollapseCategories: true,
},
},
navbar: {
title: "Halo 文档",
logo: {
alt: "Halo Logo",
src: "https://www.halo.run/upload/2021/03/Adaptive256-463ca9b92e2d40268431018c07735842.png",
},
items: [
{
type: "docSidebar",
position: "left",
sidebarId: "tutorial",
label: "使用指南",
},
{
type: "docSidebar",
position: "left",
sidebarId: "developer",
label: "开发者指南",
},
{
type: "docsVersionDropdown",
position: "right",
dropdownActiveClassDisabled: true,
dropdownItemsAfter: [
{
type: "html",
value: '<hr class="dropdown-separator">',
},
{
type: "html",
className: "dropdown-archived-versions",
value: "<b>Archived versions</b>",
},
...Object.entries(VersionsArchived).map(
([versionName, versionUrl]) => ({
label: versionName,
href: versionUrl,
})
),
{
to: "/versions",
label: "All versions",
},
],
},
{
href: "https://www.halo.run",
label: "官网",
position: "right",
},
{
href: "https://bbs.halo.run",
label: "论坛",
position: "right",
},
{
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 © 2023 凌霞软件. Built with Docusaurus.`,
links: [
{
title: "关于",
items: [
{
label: "官网",
href: "https://www.halo.run",
},
{
label: "应用市场",
href: "https://www.halo.run/store/apps",
},
{
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://www.halo.run/upload/2021/03/B3C27F16-4890-4633-81CC-20BA4B28F94F-2415126255c749b290312ca22d9bdeb0.jpeg",
},
{
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,
additionalLanguages: ["java", "json", "sql", "diff"],
},
zoom: {
selector: ".markdown :not(a) > img",
},
}),
plugins: [require.resolve("docusaurus-plugin-image-zoom")],
scripts: [
{
src: "https://track.halo.run/api/script.js",
defer: true,
"data-site-id": "3",
},
],
};
module.exports = config;