zitadel/docs/docusaurus.config.js

175 lines
4.4 KiB
JavaScript
Raw Normal View History

/** @type {import('@docusaurus/types').DocusaurusConfig} */
module.exports = {
2022-02-02 13:45:01 +01:00
title: "ZITADEL Docs",
trailingSlash: false,
url: "https://docs.zitadel.com",
2022-02-02 13:45:01 +01:00
baseUrl: "/",
onBrokenLinks: "warn",
2022-02-02 13:45:01 +01:00
onBrokenMarkdownLinks: "warn",
favicon: "img/favicon.ico",
organizationName: "zitadel",
2022-02-02 13:45:01 +01:00
projectName: "zitadel",
scripts: [
{
src: "/proxy/js/script.js",
async: true,
defer: true,
"data-domain": "docs.zitadel.com",
2022-02-02 13:45:01 +01:00
"data-api": "/proxy/api/event",
},
],
themeConfig: {
2022-02-02 13:45:01 +01:00
zoomSelector: ".markdown :not(em) > img",
2022-05-19 11:00:44 +02:00
announcementBar: {
id: 'documentation',
content:
2022-05-23 09:04:51 +02:00
'This page contains the documentation for ZITADEL version 2, if you are looking for version 1 please visit <a target="_blank" rel="noopener noreferrer" href="https://docs-v1.zitadel.com">https://docs-v1.zitadel.com</a>',
2022-05-19 11:00:44 +02:00
backgroundColor: '#fafbfc',
textColor: '#091E42',
isCloseable: false,
},
navbar: {
// title: 'ZITADEL',
logo: {
2022-02-02 13:45:01 +01:00
alt: "ZITADEL logo",
src: "img/zitadel-logo-dark.svg",
srcDark: "img/zitadel-logo-light.svg",
},
items: [
{
2022-02-02 13:45:01 +01:00
type: "doc",
label: "Guides",
docId: "guides/overview",
position: "left",
},
{
2022-02-02 13:45:01 +01:00
type: "doc",
label: "Quickstarts",
docId: "quickstarts/introduction",
position: "left",
},
{
2022-02-02 13:45:01 +01:00
type: "doc",
label: "APIs",
docId: "apis/introduction",
position: "left",
},
{
2022-02-02 13:45:01 +01:00
type: "doc",
docId: "concepts/introduction",
label: "Concepts",
position: "left",
},
docs: restructure and add more content (#2232) * docs: restructure quickstarts * docs: quickstart libs * docs: add exlixir lib * docs: restructure * docs: restructure * docs: customization * use tabs in oauth/oidc endpoints.md * improve authorize_endpoint * improve token_endpoint and introspection_endpoint * docs: saas use case * styling * styling * begin login users * login users * login users * fix table * fix: links * fix: links * start go api * fix: policy structure * fix: saas description * fix: saas description * fix: saas description * Update docs/docs/concepts/policies.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * docs: organisation --> organization * docs: fixes * docs: fixes * Update docs/docs/apis/openidoauth/endpoints.md Co-authored-by: Florian Forster <florian@caos.ch> * Update docs/docs/concepts/policies.md Co-authored-by: Florian Forster <florian@caos.ch> * Update docs/docs/concepts/policies.md Co-authored-by: Florian Forster <florian@caos.ch> * Update docs/docs/concepts/policies.md Co-authored-by: Florian Forster <florian@caos.ch> * Update docs/docs/apis/openidoauth/endpoints.md Co-authored-by: Florian Forster <florian@caos.ch> * Apply suggestions from code review Co-authored-by: Florian Forster <florian@caos.ch> * docs: intro * Update docs/docs/guides/customization/branding.md Co-authored-by: Florian Forster <florian@caos.ch> * fix: typo * add mermaid Co-authored-by: Livio Amstutz <livio.a@gmail.com> Co-authored-by: mffap <mpa@caos.ch> Co-authored-by: Florian Forster <florian@caos.ch>
2021-09-23 10:34:06 +02:00
{
2022-02-02 13:45:01 +01:00
type: "doc",
docId: "manuals/introduction",
label: "Help",
position: "left",
docs: restructure and add more content (#2232) * docs: restructure quickstarts * docs: quickstart libs * docs: add exlixir lib * docs: restructure * docs: restructure * docs: customization * use tabs in oauth/oidc endpoints.md * improve authorize_endpoint * improve token_endpoint and introspection_endpoint * docs: saas use case * styling * styling * begin login users * login users * login users * fix table * fix: links * fix: links * start go api * fix: policy structure * fix: saas description * fix: saas description * fix: saas description * Update docs/docs/concepts/policies.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * Update docs/docs/concepts/usecases/saas.md Co-authored-by: mffap <mpa@caos.ch> * docs: organisation --> organization * docs: fixes * docs: fixes * Update docs/docs/apis/openidoauth/endpoints.md Co-authored-by: Florian Forster <florian@caos.ch> * Update docs/docs/concepts/policies.md Co-authored-by: Florian Forster <florian@caos.ch> * Update docs/docs/concepts/policies.md Co-authored-by: Florian Forster <florian@caos.ch> * Update docs/docs/concepts/policies.md Co-authored-by: Florian Forster <florian@caos.ch> * Update docs/docs/apis/openidoauth/endpoints.md Co-authored-by: Florian Forster <florian@caos.ch> * Apply suggestions from code review Co-authored-by: Florian Forster <florian@caos.ch> * docs: intro * Update docs/docs/guides/customization/branding.md Co-authored-by: Florian Forster <florian@caos.ch> * fix: typo * add mermaid Co-authored-by: Livio Amstutz <livio.a@gmail.com> Co-authored-by: mffap <mpa@caos.ch> Co-authored-by: Florian Forster <florian@caos.ch>
2021-09-23 10:34:06 +02:00
},
{
2022-02-02 13:45:01 +01:00
type: "doc",
docId: "legal/introduction",
label: "Legal",
position: "left",
},
{
href: "https://github.com/zitadel/zitadel",
2022-02-02 13:45:01 +01:00
label: "GitHub",
position: "right",
},
],
},
footer: {
links: [
{
2022-02-02 13:45:01 +01:00
title: "Community",
items: [
{
label: "Chat",
href: "https://zitadel.com/chat",
},
{
2022-02-02 13:45:01 +01:00
label: "GitHub Discussions",
href: "https://github.com/zitadel/zitadel/discussions",
},
{
2022-02-02 13:45:01 +01:00
label: "Twitter",
href: "https://twitter.com/zitadel",
},
{
2022-02-02 13:45:01 +01:00
label: "Linkedin",
href: "https://www.linkedin.com/company/zitadel/",
},
{
2022-02-02 13:45:01 +01:00
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",
},
{
2022-02-02 13:45:01 +01:00
label: "Contact",
href: "https://zitadel.com/contact/",
},
{
2022-02-02 13:45:01 +01:00
label: "GitHub",
href: "https://github.com/zitadel",
},
{
2022-02-02 13:45:01 +01:00
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: {
2022-02-02 13:45:01 +01:00
additionalLanguages: ["csharp", "dart", "groovy"],
},
},
presets: [
[
2022-02-02 13:45:01 +01:00
"@docusaurus/preset-classic",
{
docs: {
2022-02-02 13:45:01 +01:00
sidebarPath: require.resolve("./sidebars.js"),
editUrl: "https://github.com/zitadel/zitadel/edit/v2-alpha/docs/",
2022-02-02 13:45:01 +01:00
remarkPlugins: [require("mdx-mermaid")],
},
theme: {
2022-02-02 13:45:01 +01:00
customCss: require.resolve("./src/css/custom.css"),
},
},
],
],
2022-02-02 13:45:01 +01:00
plugins: [require.resolve("plugin-image-zoom")],
};