trade-api-docs/docusaurus.config.js at master · FinamWeb/trade-api-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
// @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 domain = "https://finamweb.github.io";
const pathname = "/trade-api-docs/";
const metaImageUrl = `${domain}${pathname}img/meta-image.png`;

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "Trade API",
  tagline:
    "Сервис для организации взаимодействия пользовательских приложений с сервером TRANSAQ",
  url: domain,
  baseUrl: pathname,
  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "warn",
  favicon: "img/favicon.ico",
  trailingSlash: false,

  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: "finamweb", // Usually your GitHub org/user name.
  projectName: "trade-api-docs", // Usually your repo name.
  deploymentBranch: "gh-pages",

  // 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: "ru",
    locales: ["ru"],
  },

  presets: [
    [
      "classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          // Serve the docs at the site's root
          routeBasePath: "/",
          sidebarPath: require.resolve("./sidebars.js"),
        },
        blog: false,
        theme: {
          customCss: require.resolve("./src/custom.css"),
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      metadata: [
        { name: "twitter:card", content: "summary_large_image" },
        {
          name: "twitter:image",
          content: metaImageUrl,
        },
        {
          property: "og:image:secure_url",
          content: metaImageUrl,
        },
        {
          property: "og:image",
          content: metaImageUrl,
        },
        {
          property: "og:image:width",
          content: "1200",
        },
        {
          property: "og:image:height",
          content: "630",
        },
        {
          property: "og:image:alt",
          content: "Trade API — Все самое необходимое для алготрейдинга",
        },
      ],
      navbar: {
        title: "Trade API",
        logo: {
          alt: "Trade API Logo",
          src: "img/logo.png",
        },
        items: [
          {
            type: "doc",
            docId: "common-info",
            position: "left",
            label: "Документация",
          },
          {
            href: "https://trade-api.finam.ru/swagger/index.html",
            label: "Swagger",
            position: "left",
          },
          {
            href: "https://vk.com/finam_trade_api",
            label: "Trade API VK",
            position: "right",
          },
          {
            href: "mailto:trade_api@corp.finam.ru",
            label: "Обратная связь",
            position: "right",
          },
          {
            href: "https://github.com/FinamWeb/trade-api-docs",
            label: "GitHub",
            position: "right",
          },
        ],
      },
      footer: {
        style: "dark",
        links: [
          {
            label: "Документация",
            to: "/",
          },
          {
            label: "Swagger",
            href: "https://trade-api.finam.ru/swagger/index.html",
          },
        ],
      },
      colorMode: {
        respectPrefersColorScheme: true,
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
      },
    }),
};

module.exports = config;