feature-flags-co-docs/docusaurus.config.js at main · feature-flags-co/feature-flags-co-docs · 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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: '敏捷开关',
  staticDirectories: ['static'],
  tagline: '聪明的团队会交付',
  url: 'https://featureflag.co',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',
  favicon: 'img/logo.svg',
  organizationName: '北京心跳率科技有限公司', // Usually your GitHub org/user name.
  projectName: '敏捷开关', // Usually your repo name.
  // themes: ['@docusaurus/theme-search-algolia'],
  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: require.resolve('./sidebars.js'),
          // Please change this to your repo.
          // editUrl: 'https://github.com/feature-flags-co/feature-flags-co-docs',
        },
        blog: {
          showReadingTime: true,
          // Please change this to your repo.
          editUrl:
            'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
        },
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
      }),
    ],
  ],
  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      navbar: {
        title: '敏捷开关 | 文档手册',
        logo: {
          alt: '敏捷开关Logo',
          src: 'img/logo.png',
        },
        hideOnScroll: false,
        items: [
          {
            type: 'doc',
            docId: '概览',
            position: 'left',
            label: '使用文档',
          },
          // {
          //   to: '/integration',
          //   label: '应用集成',
          //   position: 'left'
          // },
          // {
          //   to: '/docs/sdks/overview',
          //   position: 'left',
          //   label: '开发集成(SDKs&APIs)',
          // },
          { href: 'https://zhuanlan.zhihu.com/p/431153001', label: '使用指南', position: 'left' },
          { href: 'https://portal.featureflag.co', label: '应用后台', position: 'left' },

          // {
          //   type: 'localeDropdown',
          //   position: 'right',
          // },
          {
            href: 'https://github.com/feature-flags-co/feature-flags-co/',
            label: ' ',
            position: 'right',
            className: 'header-github-link', 'aria-label': 'GitHub repository',
            target: '_blank'
          },
          // {
          //   type: 'search',
          //   position: 'right',
          // },
        ],
      },
      tableOfContents: {
        maxHeadingLevel: 5,
      },
      prism: {
        theme: lightCodeTheme,
        // darkTheme: darkCodeTheme,
      },
      // algolia: {
      //   // The application ID provided by Algolia
      //   appId: 'EMOB5QI6ZL',

      //   // Public API key: it is safe to commit it
      //   apiKey: '786a9155e7266ee47d29a75ef846cf9a',

      //   indexName: 'featureflagco_doc',

      //   // Optional: see doc section below
      //   contextualSearch: true,

      //   // Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them.
      //   externalUrlRegex: 'external\\.com|domain\\.com',

      //   // Optional: Algolia search parameters
      //   searchParameters: {},

      //   // Optional: path for search page that enabled by default (`false` to disable it)
      //   searchPagePath: 'search',

      //   //... other Algolia params
      // },
      colorMode: {
        defaultMode: 'light',
        disableSwitch: true,
        respectPrefersColorScheme: false,
      },
      i18n: {
        defaultLocale: 'en',
        locales: ['en', 'zh'],
        en: {
          htmlLang: 'zh-CN',
        },
        zh: {
          htmlLang: 'zh-CN',
        },
      },
    }),
  plugins: [
  ]
};

module.exports = config;