easybtn-docs/docusaurus.config.ts at main · evert-arias/easybtn-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
154
155
156
157
158
159
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
import { themes as prismThemes } from "prism-react-renderer";

const config: Config = {
  title: "EasyButton",
  tagline:
    "Arduino library for debouncing momentary contact switches, detect press, release, long press and sequences with event definitions and callbacks.",

  // Set the production url of your site here
  url: "https://evert-arias.github.io",

  // Set the /<baseUrl>/ pathname under which your site is served
  // For GitHub pages deployment, it is often '/<projectName>/'
  baseUrl: "/easybtn-docs",

  favicon: "img/favicon.ico",
  organizationName: "evert-arias",
  projectName: "EasyButton",

  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "warn",

  // Even if you don't use internationalization, 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: "en",
    locales: ["en"],
  },

  presets: [
    [
      "classic",
      {
        docs: {
          sidebarPath: "./sidebars.ts",
          editUrl: "https://github.com/evert-arias/easybtn-docs",
        },
        theme: {
          customCss: "./src/css/custom.css",
        },
        gtag: {
          trackingID: "UA-137998950-8",
          anonymizeIP: true,
        },
      } satisfies Preset.Options,
    ],
  ],

  themeConfig: {
    image: "img/logo.svg",
    navbar: {
      title: "EasyButton",
      logo: {
        alt: "EasyButton Logo",
        src: "img/logo.svg",
      },
      items: [
        {
          to: "docs/introduction",
          sidebarId: "docs",
          label: "Docs",
          position: "left",
        },
        {
          to: "docs/on-single-press-api",
          sidebarId: "api",
          label: "API",
          position: "left",
        },
        {
          to: "docs/on-single-press-example",
          sidebarId: "examples",
          label: "Examples",
          position: "left",
        },
        { to: "/contributors", label: "Contributors", position: "left" },
        // { to: "https://blog.treve.dev", label: "Blog", position: "right" },
        {
          href: "https://github.com/evert-arias/EasyButton",
          label: "GitHub",
          position: "right",
        },
      ],
    },
    footer: {
      style: "dark",
      links: [
        {
          title: "Docs",
          items: [
            {
              label: "Introduction",
              to: "docs/introduction",
            },
            {
              label: "Installation",
              to: "docs/installation",
            },
            {
              label: "Fundamentals",
              to: "docs/fundamentals",
            },
          ],
        },
        {
          title: "Examples",
          items: [
            {
              label: "Single Press",
              to: "docs/on-single-press-example",
            },
            {
              label: "Detecting Sequence",
              to: "docs/on-sequence-example",
            },
            {
              label: "Pressed For Duration",
              to: "docs/on-pressed-for-duration-example",
            },
          ],
        },
        {
          title: "Community",
          items: [
            // {
            //   label: "Blog",
            //   to: "https://blog.treve.dev/",
            // },
            {
              label: "GitHub",
              href: "https://github.com/evert-arias/EasyButton",
            },
            {
              label: "Youtube",
              href: "https://www.youtube.com/@trevedev",
            },
          ],
        },
      ],
      copyright: `Made with 💙 by <a target="_blank" rel="noopener noreferrer" href="https://github.com/evert-arias">Evert Arias</a>`,
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
    },
    announcementBar: {
      id: "v3_development",
      content:
        '🚀 EasyButton 3.0 in development! Major bug fixes and improvements coming soon. <a target="_blank" rel="noopener noreferrer" href="https://github.com/evert-arias/EasyButton/discussions/100">Learn more</a>',
      backgroundColor: "#4051b5",
      textColor: "#ffffff",
      isCloseable: false,
    },
  } satisfies Preset.ThemeConfig,
};

export default config;