website/docusaurus.config.js at main · YOURLS/website · 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
// @ts-check

const codeThemes = require('prism-react-renderer').themes

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'YOURLS',
  tagline: 'Your Own URL Shortener',
  url: 'https://yourls.org',
  baseUrl: '/',
  trailingSlash: false,
  onBrokenLinks: 'throw',
  favicon: 'assets/images/favicon.svg',

  // GitHub pages deployment config.
  organizationName: 'YOURLS',
  projectName: 'website',

  markdown: {
    hooks: {
      onBrokenMarkdownLinks: 'warn',
    },
  },

  // Even if you don't use internalization, you can use this field to set useful
  // metadata like html lang. For example, if your site is Chinese, you may want
  // to replace "en" with "zh-Hans".
  i18n: {
    defaultLocale: 'en',
    locales: ['en'],
  },

  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: require.resolve('./sidebars.js'),
          editUrl: 'https://github.com/YOURLS/website/edit/main/',
        },
        blog: {
          showReadingTime: true,
          blogSidebarTitle: 'Latest posts',
          blogSidebarCount: 10,
        },
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      image: 'assets/images/splash.png',
      navbar: {
        title: 'YOURLS',
        logo: {
          alt: 'YOURLS Logo',
          src: 'assets/images/favicon.svg',
        },
        items: [
          {
            type: 'search',
            position: 'left',
          },
          {
            type: 'doc',
            docId: 'introduction',
            position: 'right',
            label: 'Docs',
          },
          {
            type: 'docSidebar',
            position: 'right',
            sidebarId: 'dev',
            label: 'Development',
          },
          { to: '/blog', label: 'Blog', position: 'right' },
          {
            type: 'dropdown',
            position: 'right',
            label: 'Resources',
            items: [
              {
                label: 'Awesome YOURLS',
                href: 'https://github.com/YOURLS/awesome-yourls',
              },
              {
                label: 'Plugin sample',
                href: 'https://github.com/YOURLS/plugin-sample',
              },
            ],
          },
          {
            type: 'dropdown',
            position: 'right',
            label: 'References',
            items: [
              { label: 'Hooklist', href: 'https://yourls.org/hooklist.php' },
              { label: 'XRef', href: 'https://yourls.org/xref/' },
            ],
          },
          { to: 'sponsor', label: 'Sponsor', position: 'right' },
          {
            href: 'https://github.com/YOURLS/YOURLS',
            label: 'GitHub',
            position: 'right',
          },
        ],
      },
      footer: {
        style: 'dark',
        copyright: `Code licensed MIT, documentation CC BY 4.0<br>Copyright © 2009-present · YOURLS Contributors`,
      },
      prism: {
        theme: codeThemes.github,
        darkTheme: codeThemes.dracula,
        additionalLanguages: ['php', 'apacheconf', 'nginx'],
      },
      algolia: {
        appId: '0OPRSQO7WN',
        apiKey: '690f80e826ffeb1920dea258742fb626',
        indexName: 'yourls',
      },
    }),
}

module.exports = config