docs/docusaurus.config.js at main · onflowser/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
// @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');

const metaDescription = 'Flowser is first-of-its-kind development tool for Flow blockchain. It does the heavy work of managing blockchain emulator, inspecting the current state, interacting with the network and much more!';

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Flowser Docs',
  tagline: metaDescription,
  url: 'https://docs.flowser.dev',
  baseUrl: '/',
  onBrokenLinks: 'warn',
  onBrokenMarkdownLinks: 'warn',
  favicon: 'img/favicon.ico',
  organizationName: 'onflowser', // Usually your GitHub org/user name.
  projectName: 'docs', // Usually your repo name.

  scripts: [{
    src: 'https://cdn.splitbee.io/sb.js',
    async: true,
    'data-no-cookie': true
  }],

  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          routeBasePath: '/',
          sidebarPath: require.resolve('./sidebars.js'),
          editUrl: 'https://github.com/onflowser/docs/tree/main',
        },
        blog: false,
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
      }),
    ],
  ],

  themeConfig:
  /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      metadata: [
        { name: 'description', content: metaDescription },
        { property: 'og:description', content: metaDescription },
        { property: 'og:title', content: 'Flowser docs' },
        { property: 'og:site_name', content: 'Flowser' },
        {
          property: 'og:image',
          content: 'https://flowser.dev/social.png'
        },
        { property: 'og:type', content: 'documentation' },
        { name: 'twitter:description', content: metaDescription },
        {
          name: 'twitter:image',
          content: 'https://flowser.dev/social.png'
        },
        { rel: 'canonical', content: 'https://docs.flowser.dev' },
      ],
      navbar: {
        title: 'Flowser docs',
        logo: {
          alt: 'Flowser Logo',
          src: 'img/logo.png',
        },
        items: [
          // {
          //   type: 'doc',
          //   docId: 'overview',
          //   position: 'left',
          //   label: 'Tutorial',
          // },
          {
            href: 'https://flowser.dev',
            label: 'Website',
            position: 'right',
          },
          {
            href: 'https://github.com/onflowser/flowser',
            label: 'GitHub',
            position: 'right',
          },
        ],
      },
      footer: {
        style: 'dark',
        links: [
          {
            title: 'Docs',
            items: [
              {
                label: 'What is Flowser?',
                to: '/overview',
              },
              {
                label: 'Quickstart',
                to: '/quick-start',
              },
              {
                label: 'Features',
                to: '/features',
              },
              {
                label: 'Contributing',
                to: '/contributing',
              },
              {
                label: 'Development guide',
                to: '/development',
              },
            ],
          },
          {
            title: 'Community',
            items: [
              {
                label: 'Twitter',
                href: 'https://twitter.com/onflowser',
              },
            ],
          },
          {
            title: 'More',
            items: [
              {
                label: 'Website',
                to: 'https://flowser.dev',
              },
              {
                label: 'Blog',
                to: 'https://flowser.dev/blog',
              },
              {
                label: 'GitHub',
                href: 'https://github.com/onflowser/flowser',
              },
            ],
          },
        ],
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
      },
    }),
};

module.exports = config;