FEAScript-documentation/docusaurus.config.js at main · FEAScript/FEAScript-documentation · 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
// @ts-check
import { themes as prismThemes } from "prism-react-renderer";
import remarkMath from "remark-math";
import rehypeKatex from "rehype-katex";

// Code blocks are dark in both modes, like the terminal snippets on feascript.com
const darkCode = {
  ...prismThemes.dracula,
  plain: { ...prismThemes.dracula.plain, backgroundColor: "#1f1f1f" },
};

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "FEAScript Documentation",
  tagline: "Finite element simulation library built in JavaScript",
  favicon: "img/favicon.ico",

  url: "https://docs.feascript.com",
  baseUrl: "/",

  organizationName: "FEAScript",
  projectName: "FEAScript-documentation",
  trailingSlash: false,

  onBrokenLinks: "throw",
  markdown: {
    hooks: {
      onBrokenMarkdownLinks: "throw",
    },
  },

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

  presets: [
    [
      "classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          routeBasePath: "/",
          sidebarPath: "./sidebars.js",
          editUrl: "https://github.com/FEAScript/FEAScript-documentation/tree/main/",
          remarkPlugins: [remarkMath],
          rehypePlugins: [rehypeKatex],
          // "current" holds the unreleased docs; released versions are snapshots (see README)
          lastVersion: "current",
          versions: {
            current: { label: "0.3.0-RC (dev)" },
          },
        },
        blog: false,
        theme: {
          customCss: "./src/css/custom.css",
        },
      }),
    ],
  ],

  headTags: [
    { tagName: "link", attributes: { rel: "preconnect", href: "https://fonts.googleapis.com" } },
    {
      tagName: "link",
      attributes: { rel: "preconnect", href: "https://fonts.gstatic.com", crossorigin: "anonymous" },
    },
  ],

  stylesheets: [
    {
      href: "https://fonts.googleapis.com/css2?family=Roboto+Mono:wght@400&family=Roboto:wght@300;400;500;700&display=swap",
      type: "text/css",
    },
    {
      href: "https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.css",
      type: "text/css",
      crossorigin: "anonymous",
    },
  ],

  themes: [
    [
      "@easyops-cn/docusaurus-search-local",
      /** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
      ({
        hashed: true,
        indexBlog: false,
        docsRouteBasePath: "/",
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      navbar: {
        items: [
          { type: "docsVersionDropdown", position: "right" },
          {
            type: "custom-github",
            position: "right",
          },
        ],
      },
      footer: {
        style: "light",
        links: [
          {
            title: "FEAScript",
            items: [
              { label: "Website", href: "https://feascript.com" },
              { label: "FEAScript Studio", href: "https://feascript.com/studio.html" },
              { label: "Blog", href: "https://blog.feascript.com" },
            ],
          },
          {
            title: "Community",
            items: [
              { label: "Discord", href: "https://discord.gg/3DVjNcuW4f" },
              { label: "GitHub", href: "https://github.com/FEAScript/FEAScript-core" },
              { label: "YouTube", href: "https://www.youtube.com/@FEAScript" },
              { label: "LinkedIn", href: "https://www.linkedin.com/company/feascript/" },
            ],
          },
        ],
        copyright: `<span>&#169; 2023-${new Date().getFullYear()} FEAScript</span><span>Core: MIT license &middot; Docs: CC BY 4.0</span>`,
      },
      prism: {
        theme: darkCode,
        darkTheme: darkCode,
        additionalLanguages: ["bash"],
      },
    }),
};

export default config;