autogen

1
/** @type {import('@docusaurus/types').DocusaurusConfig} */
2
const math = require("remark-math");
3
const katex = require("rehype-katex");
4

5
customPostCssPlugin = () => {
6
  return {
7
    name: "custom-postcss",
8
    configurePostCss(options) {
9
      options.plugins.push(require("postcss-preset-env"));
10
      return options;
11
    }
12
  };
13
}
14

15
module.exports = {
16
  title: "AutoGen",
17
  tagline: "Enable Next-Gen Large Language Model Applications",
18
  url: "https://microsoft.github.io",
19
  baseUrl: "/autogen/",
20
  onBrokenLinks: "throw",
21
  onBrokenMarkdownLinks: "warn",
22
  favicon: "img/ag.ico",
23
  organizationName: "Microsoft", // Usually your GitHub org/user name.
24
  projectName: "AutoGen", // Usually your repo name.
25
  scripts: [
26
    {
27
      src: '/autogen/js/custom.js',
28
      async: true,
29
      defer: true,
30
    },
31
  ],
32
  markdown: {
33
    format: 'detect', // Support for MD files with .md extension
34
  },
35
  themeConfig: {
36
    docs: {
37
      sidebar: {
38
        autoCollapseCategories: true,
39
      },
40
    },
41
    navbar: {
42
      title: "AutoGen",
43
      logo: {
44
        alt: "AutoGen",
45
        src: "img/ag.svg",
46
      },
47
      items: [
48
        {
49
          type: "dropdown",
50
          position: "left",
51
          label: "Docs",
52
          items: [
53
            {
54
              type: "doc",
55
              label: "Getting Started",
56
              docId: "Getting-Started",
57
            },
58
            {
59
              type: "doc",
60
              label: "Installation",
61
              docId: "installation/Installation",
62
            },
63
            {
64
              type: "doc",
65
              label: "Tutorial",
66
              docId: "tutorial/introduction",
67
            },
68
            {
69
              type: "doc",
70
              label: "User Guide",
71
              docId: "topics",
72
            },
73
            {
74
              type: "doc",
75
              docId: "reference/agentchat/conversable_agent",
76
              label: "API Reference",
77
            },
78
            {
79
              type: "doc",
80
              docId: "FAQ",
81
              label: "FAQs",
82
            },
83
            {
84
              type: "doc",
85
              docId: "ecosystem",
86
              label: "Ecosystem",
87
            },
88
            {
89
              type: "doc",
90
              label: "Contributor Guide",
91
              docId: "contributor-guide/contributing",
92
            },
93
            {
94
              type: "doc",
95
              label: "Research",
96
              docId: "Research",
97
            },
98
          ],
99
        },
100
        {
101
          type: "dropdown",
102
          position: "left",
103
          label: "Examples",
104
          items: [
105
            {
106
              type: "doc",
107
              label: "Examples by Category",
108
              docId: "Examples",
109
            },
110
            {
111
              type: "doc",
112
              label: "Examples by Notebook",
113
              docId: "notebooks",
114
            },
115
            {
116
              type: "doc",
117
              label: "Application Gallery",
118
              docId: "Gallery",
119
            },
120
          ],
121
        },
122
        {
123
          label: "Other Languages",
124
          type: "dropdown",
125
          position: "left",
126
          items: [
127
            {
128
              label: "Dotnet",
129
              href: "https://microsoft.github.io/autogen-for-net/",
130
            }
131
          ],
132

133
        },
134
        {
135
          to: "blog",
136
          label: "Blog",
137
          position: "left",
138
        },
139
        {
140
          href: "https://github.com/microsoft/autogen",
141
          label: "GitHub",
142
          position: "right",
143
        },
144
        {
145
          href: "https://aka.ms/autogen-dc",
146
          label: "Discord",
147
          position: "right",
148
        },
149
        {
150
          href: "https://twitter.com/pyautogen",
151
          label: "Twitter",
152
          position: "right",
153
        },
154
      ],
155
    },
156
    footer: {
157
      style: "dark",
158
      links: [
159
        // {
160
        //   title: 'Docs',
161
        //   items: [
162
        //     {
163
        //       label: 'Getting Started',
164
        //       to: 'docs/getting-started',
165
        //     },
166
        //   ],
167
        // },
168
        {
169
          title: "Community",
170
          items: [
171
            //     // {
172
            //     //   label: 'Stack Overflow',
173
            //     //   href: 'https://stackoverflow.com/questions/tagged/pymarlin',
174
            //     // },
175
            {
176
              label: "Discord",
177
              href: "https://aka.ms/autogen-dc",
178

179
            },
180
            {
181
              label: "Twitter",
182
              href: "https://twitter.com/pyautogen",
183
            },
184
          ],
185
        },
186
      ],
187
      copyright: `Copyright © ${new Date().getFullYear()} AutoGen Authors |  <a target="_blank" style="color:#10adff" href="https://go.microsoft.com/fwlink/?LinkId=521839">Privacy and Cookies</a>`,
188
    },
189
    announcementBar: {
190
      id: 'whats_new',
191
      content:
192
        'What\'s new in AutoGen? Read <a href="/autogen/blog/2024/03/03/AutoGen-Update">this blog</a> for an overview of updates',
193
      backgroundColor: '#fafbfc',
194
      textColor: '#091E42',
195
      isCloseable: true,
196
    },
197
    /* Clarity Config */
198
    clarity: {
199
      ID: "lnxpe6skj1", // The Tracking ID provided by Clarity
200
    }
201
  },
202
  presets: [
203
    [
204
      "@docusaurus/preset-classic",
205
      {
206
        blog: {
207
          showReadingTime: true,
208
          blogSidebarCount: "ALL",
209
          // Adjust any other blog settings as needed
210
        },
211
        docs: {
212
          sidebarPath: require.resolve("./sidebars.js"),
213
          // Please change this to your repo.
214
          editUrl: "https://github.com/microsoft/autogen/edit/main/website/",
215
          remarkPlugins: [math],
216
          rehypePlugins: [katex],
217
        },
218
        theme: {
219
          customCss: require.resolve("./src/css/custom.css"),
220
        },
221
      },
222
    ],
223
  ],
224
  stylesheets: [
225
    {
226
      href: "https://cdn.jsdelivr.net/npm/katex@0.13.11/dist/katex.min.css",
227
      integrity:
228
        "sha384-Um5gpz1odJg5Z4HAmzPtgZKdTBHZdw8S29IecapCSB31ligYPhHQZMIlWLYQGVoc",
229
      crossorigin: "anonymous",
230
    },
231
  ],
232

233
  plugins: [
234
    [
235
      require.resolve("@easyops-cn/docusaurus-search-local"),
236
      {
237
        // ... Your options.
238
        // `hashed` is recommended as long-term-cache of index file is possible.
239
        hashed: true,
240
        blogDir: "./blog/",
241
        // For Docs using Chinese, The `language` is recommended to set to:
242
        // ```
243
        // language: ["en", "zh"],
244
        // ```
245
        // When applying `zh` in language, please install `nodejieba` in your project.
246
      },
247
    ],
248
    customPostCssPlugin,
249
    [
250
      "@docusaurus/plugin-client-redirects",
251
      {
252
        redirects: [
253
          {
254
            to: "/docs/topics/llm_configuration",
255
            from: ["/docs/llm_endpoint_configuration/"],
256
          },
257
          {
258
            to: "/docs/Getting-Started",
259
            from: ["/docs/"],
260
          },
261
          {
262
            to: "/docs/topics/llm_configuration",
263
            from: ["/docs/llm_configuration"],
264
          },
265
          {
266
            to: "/docs/tutorial/chat-termination",
267
            from: ["/docs/tutorial/termination"],
268
          },
269
          {
270
            to: "/docs/tutorial/what-next",
271
            from: ["/docs/tutorial/what-is-next"],
272
          },
273
          {
274
            to: "/docs/topics/non-openai-models/local-lm-studio",
275
            from: ["/docs/topics/non-openai-models/lm-studio"],
276
          },
277
          {
278
            to: "/docs/notebooks/agentchat_nested_chats_chess",
279
            from: ["/docs/notebooks/agentchat_chess"],
280
          },
281
          {
282
            to: "/docs/contributor-guide/contributing",
283
            from: ["/docs/Contribute"],
284
          }
285
        ],
286
      },
287
    ],
288
    [
289
      'docusaurus-plugin-clarity',
290
      {
291
      }
292
    ],
293
  ],
294
};
295