zitadel/docs/docusaurus.config.js
Florian Forster 3c3bce1a6b
docs: improve documentation for v2 release (#4046)
* WIP: docs(proxy): describe proxy settings

* fix nginx

* refactor (docs): deploy and operate sections

* chore: ignore package-lock since we use yarn

* chore: update to rc1

* chore: broken links

* chore: update yarn

* docs: move disclaimer to bottom

* chore: fix broken links

* Update docs/docs/guides/operate/tls_modes.mdx

Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>

* test caddy files

* syntax highlight

* traefik example

* refactor: docs

* refactor

* working state

* got a working state

* remove bar

* mark rate limits for update

* remove zitadel.ch

* fix cases

* docs: zitadel quickstart

* docs: zitadel quickstart

* docs: create app and project

* docs: move customer portal docs to guides manage cloud

* docs: move customer portal docs to guides manage cloud

* docs: move customer portal docs to guides manage cloud

* docs: add help me choose in the quickstart

* docs: broken links

* fix broken links

* Update knative guide

* styling

* docs: support customer portal

* update to main instead v2-alpha

* use version 2 tag

* docs: images

* docs: move authentication and authorization guides to integrate

* docs: quickstart use examples

* docs: lb example

* fix broken link

* docs: update userinfo endpoints

* docs: update userinfo endpoints

* fix oidc endpoint

* docs: remove unused endpoints in app.module

Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>
Co-authored-by: Fabienne <fabienne.gerschwiler@gmail.com>
Co-authored-by: Livio Amstutz <livio.a@gmail.com>
2022-07-29 10:13:45 +02:00

187 lines
4.5 KiB
JavaScript

/** @type {import('@docusaurus/types').DocusaurusConfig} */
module.exports = {
title: "ZITADEL Docs",
trailingSlash: false,
url: "https://docs.zitadel.com",
baseUrl: "/",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
favicon: "img/favicon.ico",
organizationName: "zitadel",
projectName: "zitadel",
scripts: [
{
src: "/proxy/js/script.js",
async: true,
defer: true,
"data-domain": "docs.zitadel.com",
"data-api": "/proxy/api/event",
},
],
themeConfig: {
zoom: {
selector: '.markdown :not(em) > img',
background: {
light: 'rgb(243, 244, 246)',
dark: 'rgb(55, 59, 82)'
},
// options you can specify via https://github.com/francoischalifour/medium-zoom#usage
config: {}
},
navbar: {
// title: 'ZITADEL',
logo: {
alt: "ZITADEL logo",
src: "img/zitadel-logo-dark.svg",
srcDark: "img/zitadel-logo-light.svg",
},
items: [
{
type: "doc",
label: "Guides",
docId: "guides/overview",
position: "left",
},
{
type: "doc",
label: "Examples",
docId: "examples/introduction",
position: "left",
},
{
type: "doc",
label: "APIs",
docId: "apis/introduction",
position: "left",
},
{
type: "doc",
docId: "concepts/introduction",
label: "Concepts",
position: "left",
},
{
type: "doc",
docId: "manuals/introduction",
label: "Help",
position: "left",
},
{
type: "doc",
docId: "legal/introduction",
label: "Legal",
position: "left",
},
{
href: "https://github.com/zitadel/zitadel",
label: "GitHub",
position: "right",
},
{
href: "https://zitadel.com/chat",
label: "Chat",
position: "right",
},
{
label: "Discussions",
position: "right",
href: "https://github.com/zitadel/zitadel/discussions",
},
],
},
footer: {
links: [
{
title: "Community",
items: [
{
label: "Chat",
href: "https://zitadel.com/chat",
},
{
label: "GitHub Discussions",
href: "https://github.com/zitadel/zitadel/discussions",
},
{
label: "Twitter",
href: "https://twitter.com/zitadel",
},
{
label: "Linkedin",
href: "https://www.linkedin.com/company/zitadel/",
},
{
label: "Blog",
href: "https://zitadel.com/blog",
},
],
},
{
title: "Legal",
items: [
{
label: "Terms and Conditions",
href: "/docs/legal/terms-of-service",
},
{
label: "Privacy Policy",
href: "/docs/legal/privacy-policy",
},
],
},
{
title: "About",
items: [
{
label: "Website",
href: "https://zitadel.com",
},
{
label: "Contact",
href: "https://zitadel.com/contact/",
},
{
label: "GitHub",
href: "https://github.com/zitadel",
},
{
label: "Status",
href: "https://status.zitadel.ch/",
}
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} ZITADEL Docs - Built with Docusaurus.`,
},
algolia: {
appId: "8H6ZKXENLO",
apiKey: "124fe1c102a184bc6fc70c75dc84f96f",
indexName: 'zitadel',
selector: 'div#'
},
prism: {
additionalLanguages: ["csharp", "dart", "groovy"],
},
},
presets: [
[
"@docusaurus/preset-classic",
{
docs: {
sidebarPath: require.resolve("./sidebars.js"),
showLastUpdateAuthor: true,
showLastUpdateTime: true,
editUrl: "https://github.com/zitadel/zitadel/edit/main/docs/",
remarkPlugins: [require("mdx-mermaid")],
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
},
],
],
plugins: [require.resolve("docusaurus-plugin-image-zoom")],
};