filone-docs/docusaurus.config.js at main · FilecoinFoundationWeb/filone-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
// @ts-check
import { themes as prismThemes } from "prism-react-renderer";

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "Fil One",
  tagline: "S3 object storage built for the AI era.",
  favicon: "img/favicon.svg",
  url: "https://fil.one",
  baseUrl: "/",
  organizationName: "FilecoinFoundationWeb",
  projectName: "filone-docs",

  onBrokenLinks: "throw",

  headTags: [
    {
      tagName: "script",
      attributes: { type: "application/ld+json" },
      innerHTML: JSON.stringify({
        "@context": "https://schema.org",
        "@type": "SoftwareApplication",
        "name": "Fil One",
        "description": "S3 object storage built for the AI era. S3-compatible, backed by Filecoin for cryptographically verifiable data integrity. No egress fees, $4.99/TB/month flat rate.",
        "url": "https://fil.one",
        "applicationCategory": "DeveloperApplication",
        "operatingSystem": "Any",
        "offers": {
          "@type": "UnitPriceSpecification",
          "price": "4.99",
          "priceCurrency": "USD",
          "unitText": "TB/month"
        },
        "featureList": [
          "S3-compatible API",
          "No egress fees",
          "AES-256 encryption at rest",
          "Filecoin-backed verifiable data integrity",
          "Path-style addressing",
          "AWS SigV4 authentication",
          "30-day free trial"
        ],
        "provider": {
          "@type": "Organization",
          "name": "Filecoin Foundation",
          "url": "https://fil.org"
        }
      }),
    },
  ],

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

  i18n: {
    defaultLocale: "en",
    locales: ["en"],
  },

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

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      colorMode: {
        defaultMode: "light",
        disableSwitch: false,
        respectPrefersColorScheme: true,
      },
      navbar: {
        title: "",
        logo: {
          alt: "Fil One",
          src: "img/logo.svg",
          srcDark: "img/logo-white.svg",
        },
        items: [
          {
            to: "/",
            label: "Documentation",
            position: "left",
            activeBaseRegex: "^/(?!(reference|sdk))",
          },
          {
            to: "/reference/overview",
            label: "API Reference",
            position: "left",
          },
          {
            to: "/sdk/overview",
            label: "SDKs",
            position: "left",
          },
          {
            type: "html",
            position: "right",
            value: '<a href="https://app.fil.one/login" class="navbar-btn-secondary">Login</a>',
          },
          {
            type: "html",
            position: "right",
            value: '<a href="https://app.fil.one/login?screen_hint=signup" class="navbar-btn-primary"><span class="navbar-btn-primary-inner">Sign up</span></a>',
          },
        ],
      },

      prism: {
        theme: prismThemes.github,
        darkTheme: prismThemes.dracula,
        additionalLanguages: ["bash", "json", "python", "go", "ini"],
      },
      tableOfContents: {
        minHeadingLevel: 2,
        maxHeadingLevel: 4,
      },
    }),
};

export default config;