git.iko.soy/typeable/oauth2-proxy
on 3c06739 help sign in
typeable/oauth2-proxy/docs/docusaurus.config.js
120 lines 3.4 kB history raw
1// @ts-check
2// `@type` JSDoc annotations allow editor autocompletion and type checking
3// (when paired with `@ts-check`).
4// There are various equivalent ways to declare your Docusaurus config.
5// See: https://docusaurus.io/docs/api/docusaurus-config
7import { themes as prismThemes } from 'prism-react-renderer';
9/** @type {import('@docusaurus/types').Config} */
10const config = {
11 title: 'OAuth2 Proxy',
12 tagline: 'A lightweight authentication proxy written in Go',
13 favicon: 'img/logos/OAuth2_Proxy_icon.svg',
15 // Set the production url of your site here
16 url: 'https://oauth2-proxy.github.io',
17 // Set the /<baseUrl>/ pathname under which your site is served
18 // For GitHub pages deployment, it is often '/<projectName>/'
19 baseUrl: '/oauth2-proxy/',
21 // GitHub pages deployment config.
22 // If you aren't using GitHub pages, you don't need these.
23 organizationName: 'oauth2-proxy', // Usually your GitHub org/user name.
24 projectName: 'oauth2-proxy', // Usually your repo name.
26 onBrokenLinks: 'throw',
27 onBrokenMarkdownLinks: 'warn',
29 // Even if you don't use internationalization, you can use this field to set
30 // useful metadata like html lang. For example, if your site is Chinese, you
31 // may want to replace "en" with "zh-Hans".
32 i18n: {
33 defaultLocale: 'en',
34 locales: ['en'],
35 },
37 presets: [
38 [
39 'classic',
40 /** @type {import('@docusaurus/preset-classic').Options} */
41 ({
42 docs: {
43 sidebarPath: require.resolve('./sidebars.js'),
44 routeBasePath: '/',
45 // Please change this to your repo.
46 // Remove this to remove the "edit this page" links.
47 editUrl:
48 'https://github.com/oauth2-proxy/oauth2-proxy/edit/master/docs/',
49 },
50 blog: false,
51 theme: {
52 customCss: './src/css/custom.css',
53 },
54 }),
55 ],
56 ],
58 themes: [
59 '@docusaurus/theme-mermaid',
60 [
61 require.resolve("@easyops-cn/docusaurus-search-local"),
62 /** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
63 ({
64 hashed: true,
65 }),
66 ]
67 ],
69 markdown: {
70 mermaid: true,
71 },
73 themeConfig:
74 /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
75 ({
76 // Replace with your project's social card
77 image: 'img/logos/OAuth2_Proxy_horizontal.png',
78 navbar: {
79 title: 'OAuth2 Proxy',
80 logo: {
81 alt: 'OAuth2 Proxy',
82 src: 'img/logos/OAuth2_Proxy_icon.svg',
83 },
84 items: [
85 {
86 type: 'docSidebar',
87 sidebarId: 'docs',
88 position: 'left',
89 label: 'Docs',
90 },
91 {
92 type: 'docsVersionDropdown',
93 position: 'right',
94 dropdownActiveClassDisabled: true,
95 },
96 {
97 href: 'https://gophers.slack.com/messages/CM2RSS25N',
98 label: 'Slack',
99 position: 'right',
100 },
101 {
102 href: 'https://github.com/oauth2-proxy/oauth2-proxy',
103 label: 'GitHub',
104 position: 'right',
105 },
106 ],
107 },
108 footer: {
109 style: 'dark',
110 copyright: `Copyright © ${new Date().getFullYear()} OAuth2 Proxy.`,
111 },
112 prism: {
113 theme: prismThemes.github,
114 darkTheme: prismThemes.dracula,
115 additionalLanguages: ['hcl', 'powershell'],
116 },
117 }),
118};
120export default config;