high-performance-python/docusaurus.config.ts at master · YZXBiz/high-performance-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
import {themes as prismThemes} from 'prism-react-renderer';
import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';

// =============================================================================
// CONFIGURE YOUR PROJECT HERE
// =============================================================================
const PROJECT_NAME = 'High Performance Python';           // Display name
const GITHUB_USERNAME = 'YZXBiz';      // Your GitHub username
const REPO_NAME = 'high-performance-python';               // Repository name
// =============================================================================

const config: Config = {
  title: PROJECT_NAME,
  tagline: 'Transform complex topics into learnable knowledge',
  favicon: 'img/logo.svg',

  future: {
    v4: true,
  },

  themes: ['@docusaurus/theme-live-codeblock'],

  // GitHub Pages deployment
  url: `https://${GITHUB_USERNAME}.github.io`,
  baseUrl: `/${REPO_NAME}/`,
  organizationName: GITHUB_USERNAME,
  projectName: REPO_NAME,
  deploymentBranch: 'gh-pages',
  trailingSlash: false,

  onBrokenLinks: 'throw',

  i18n: {
    defaultLocale: 'en',
    locales: ['en'],
  },

  presets: [
    [
      'classic',
      {
        docs: {
          sidebarPath: './sidebars.ts',
          routeBasePath: '/',
          editUrl: `https://github.com/${GITHUB_USERNAME}/${REPO_NAME}/tree/master/docs/`,
        },
        blog: false,
        theme: {
          customCss: './src/css/custom.css',
        },
      } satisfies Preset.Options,
    ],
  ],

  themeConfig: {
    image: 'img/social-card.jpg',
    colorMode: {
      defaultMode: 'light',
      disableSwitch: false,
      respectPrefersColorScheme: true,
    },
    navbar: {
      title: PROJECT_NAME,
      logo: {
        alt: `${PROJECT_NAME} Logo`,
        src: 'img/logo.svg',
      },
      items: [
        {
          type: 'docSidebar',
          sidebarId: 'guideSidebar',
          position: 'left',
          label: 'Guide',
        },
        {
          href: `https://github.com/${GITHUB_USERNAME}/${REPO_NAME}`,
          label: 'GitHub',
          position: 'right',
        },
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: 'Guide',
          items: [
            {label: 'Introduction', to: '/'},
          ],
        },
        {
          title: 'More',
          items: [
            {
              label: 'GitHub',
              href: `https://github.com/${GITHUB_USERNAME}/${REPO_NAME}`,
            },
          ],
        },
      ],
      copyright: `Copyright ${new Date().getFullYear()} ${PROJECT_NAME}. Built with Docusaurus.`,
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
      additionalLanguages: ['bash', 'yaml', 'json', 'go', 'java', 'python', 'csharp'],
    },
  } satisfies Preset.ThemeConfig,
};

export default config;