convenient_service_docs/docusaurus.config.js at main · marian13/convenient_service_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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
import {themes as prismThemes} from 'prism-react-renderer';

const config = {
  title: 'Convenient Service',
  tagline: 'Yet another approach to revisit the service object pattern, but this time focusing on the unique, opinionated features',
  url: 'https://marian13.github.io',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',
  favicon: 'img/favicon.ico',
  organizationName: 'marian13',
  projectName: 'convenient_service_docs',
  i18n: {
    defaultLocale: 'en',
    locales: ['en'],
  },

  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          /**
           * NOTE: How to set docs as homepage for Docusaurus
           * https://ricard.dev/how-to-set-docs-as-homepage-for-docusaurus/
           */
          routeBasePath: '/',
          sidebarPath: './sidebars.js',
          editUrl: 'https://github.com/marian13/convenient_service_docs/blob/main',
        },
        blog: false,
        theme: {
          customCss: './src/css/custom.css',
        },
      }),
    ],
  ],

  themeConfig:
    ({
      navbar: {
        title: 'Convenient Service',
        logo: {
          alt: 'Convenient Service Logo',
          src: 'img/logo.png',
        },
        items: [
          {
            type: 'doc',
            docId: 'installation',
            position: 'left',
            label: 'Installation',
          },
          {
            type: 'doc',
            docId: '/category/basics',
            position: 'left',
            label: 'Basics',
          },
          {
            href: 'https://github.com/marian13/convenient_service',
            label: 'GitHub',
            position: 'right',
          },
        ],
      },
      footer: {
        style: 'dark',
        links: [
          {
            title: 'Docs',
            items: [
              {
                label: 'Installation',
                to: '/installation',
              },
              {
                label: 'Basics',
                to: '/category/basics',
              },
            ],
          },
          {
            title: 'Community',
            items: [
              {
                label: 'Stack Overflow',
                href: 'https://stackoverflow.com/tags/convenient-service',
              },
            ],
          },
          {
            title: 'More',
            items: [
              {
                label: 'GitHub',
                href: 'https://github.com/marian13/convenient_service',
              },
            ],
          },
        ],
        copyright: `Copyright © ${new Date().getFullYear()} Convenient Service. Built with Docusaurus.`,
      },
      prism: {
        theme: prismThemes.github,
        darkTheme: prismThemes.dracula,
        /**
         * NOTE: `'erb'` throws exception `Cannot read properties of undefined (reading 'buildPlaceholders')`.
         */
        additionalLanguages: ['ruby']
      },
      // /**
      //  * NOTE: Stopped to use Algolia since there is NO way to trigger reindexing on a free plan.
      //  *
      //  * NOTE: Algolia configuration template was copied from:
      //  * - https://docusaurus.io/docs/search#using-algolia-docsearch
      //  *
      //  * NOTE: Credentials are taken from the Algolia registration email.
      //  *
      //  * NOTE: More Algolia configuration options can be found here:
      //  * - https://docsearch.algolia.com/docs/templates/#docusaurus-v2-template
      //  *
      //  * NOTE: Docusaurus classic preset already contains Algolia. That is why NO new npm package is installed.
      //  */
      // algolia: {
      //   /**
      //    * The application ID provided by Algolia.
      //    */
      //   appId: '28FNFYWD0P',
      //
      //   /**
      //    * Public API key: it is safe to commit it.
      //    * - https://docsearch.algolia.com/docs/legacy/faq/#can-i-share-the-apikey-in-my-repo
      //    * - https://dashboard.algolia.com/account/api-keys/all?applicationId=28FNFYWD0P
      //    * - https://www.algolia.com/doc/guides/security/api-keys/#create-and-manage-your-api-keys
      //    */
      //   apiKey: '42110676756fcfbcdf9d0f0fef8cb56d',
      //
      //   /**
      //    * Index name. Can be found in the Algolia Dashboard.
      //    * - https://dashboard.algolia.com/apps/28FNFYWD0P/explorer/browse/convenient_service?searchMode=search
      //    */
      //   indexName: 'convenient_service',
      //
      //   /**
      //    * https://docusaurus.io/docs/search#contextual-search
      //    */
      //   contextualSearch: true,
      //
      //   /**
      //    * Path for search page that enabled by default (`false` to disable it).
      //    */
      //   searchPagePath: 'search',
      //
      //   /**
      //    * - https://docsearch.algolia.com/docs/crawler/#how-often-will-you-crawl-my-website
      //    * - https://www.algolia.com/doc/tools/crawler/apis/configuration/schedule/
      //    */
      //   schedule: 'every 1 day at 3:00 pm',
      // },
    }),
    plugins: [
      [
        /**
         * - https://github.com/praveenn77/docusaurus-lunr-search?tab=readme-ov-file#using-an-option-eg-languages-in-the-plugin
         */
        require.resolve('docusaurus-lunr-search'),
        {
          languages: ['en']
        },
      ],
    ],
};

export default config;