etter/docs/.vitepress/config.ts at f0c004e5bcb261ec7f75e71e639981fa548cf038 · geoblocks/etter · 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
import { defineConfig } from "vitepress";
import { withMermaid } from "vitepress-plugin-mermaid";

const baseConfig = defineConfig({
  title: "etter",
  description: "Natural language geographic query parsing using LLMs",

  base: "/etter/",

  // /api/ is generated by pdoc at build time and does not exist as .md files
  ignoreDeadLinks: [/\/api\//],
  head: [
    ["link", { rel: "preconnect", href: "https://fonts.googleapis.com" }],
    ["link", { rel: "preconnect", href: "https://fonts.gstatic.com", crossorigin: "" }],
    [
      "link",
      {
        href: "https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@400;500;600&display=swap",
        rel: "stylesheet",
      },
    ],
  ],

  themeConfig: {
    logo: "/etter-logo.png",
    siteTitle: "etter",

    nav: [
      { text: "Guide", link: "/guide/getting-started" },
      { text: "API Reference", link: "/api/etter.html" },
    ],

    sidebar: [
      {
        text: "Guide",
        items: [
          { text: "Getting Started", link: "/guide/getting-started" },
          { text: "Spatial Relations", link: "/guide/spatial-relations" },
          { text: "Datasources", link: "/guide/datasources" },
          { text: "Error Handling", link: "/guide/error-handling" },
        ],
      },
      {
        text: "Reference",
        items: [{ text: "API Reference", link: "/api/etter.html" }],
      },
    ],

    socialLinks: [{ icon: "github", link: "https://github.com/geoblocks/etter" }],

    footer: {
      message: "Released under the BSD-3-Clause License.",
      copyright: 'Sponsored by <a href="https://www.camptocamp.com" target="_blank">Camptocamp</a>',
    },

    search: {
      provider: "local",
    },
  },
});

const extendedConfig = withMermaid({
  ...baseConfig,
  // optionally, you can pass MermaidConfig
  mermaid: {
    // refer https://mermaid.js.org/config/setup/modules/mermaidAPI.html#mermaidapi-configuration-defaults for options
  },
  // optionally set additional config for plugin itself with MermaidPluginConfig
  mermaidPlugin: {
    class: "mermaid my-class", // set additional css classes for parent container
  },
});

export default extendedConfig;