git.iko.soy/typeable/oauth2-proxy
on 2bb7ea5 help sign in
typeable/oauth2-proxy/docs/docusaurus.config.js
131 lines 3.9 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 docsDir: "docs", // only index the latest docs
66 language: ["en"],
67 indexDocs: true,
68 indexBlog: false,
69 indexPages: false,
70 docsRouteBasePath: "/", // fix the default /docs path
71 searchResultLimits: 10,
72 searchBarShortcut: true,
73 removeDefaultStemmer: true, // allow for partial word matching
74 searchBarShortcutHint: true,
75 highlightSearchTermsOnTargetPage: true,
76 }),
77 ]
78 ],
80 markdown: {
81 mermaid: true,
82 },
84 themeConfig:
85 /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
86 ({
87 // Replace with your project's social card
88 image: 'img/logos/OAuth2_Proxy_horizontal.png',
89 navbar: {
90 title: 'OAuth2 Proxy',
91 logo: {
92 alt: 'OAuth2 Proxy',
93 src: 'img/logos/OAuth2_Proxy_icon.svg',
94 },
95 items: [
96 {
97 type: 'docSidebar',
98 sidebarId: 'docs',
99 position: 'left',
100 label: 'Docs',
101 },
102 {
103 type: 'docsVersionDropdown',
104 position: 'right',
105 dropdownActiveClassDisabled: true,
106 },
107 {
108 href: 'https://gophers.slack.com/messages/CM2RSS25N',
109 label: 'Slack',
110 position: 'right',
111 },
112 {
113 href: 'https://github.com/oauth2-proxy/oauth2-proxy',
114 label: 'GitHub',
115 position: 'right',
116 },
117 ],
118 },
119 footer: {
120 style: 'dark',
121 copyright: `Copyright © ${new Date().getFullYear()} OAuth2 Proxy.`,
122 },
123 prism: {
124 theme: prismThemes.github,
125 darkTheme: prismThemes.dracula,
126 additionalLanguages: ['hcl', 'powershell'],
127 },
128 }),
129};
131export default config;