habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

website/docs: switch API browser renderer to PAN (#9570)

Browse Source 
* website/docs: switch API browser renderer to PAN

https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/
Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* hey we can actually directly link to API endpoints now

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* set as sub category

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* revert sidebars back to JS for tests

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

---------

Signed-off-by: Jens Langhammer <jens@goauthentik.io>
This commit is contained in:
Jens L
2024-05-04 23:49:33 +02:00
committed by GitHub
parent 49cf10e9bd
commit 8790f7059a
7 changed files with 4157 additions and 1656 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
website/docusaurus.config.ts
View File

@ -1,6 +1,7 @@
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
import { themes as prismThemes } from "prism-react-renderer";
import type * as OpenApiPlugin from "docusaurus-plugin-openapi-docs";
module.exports = async function (): Promise<Config> {
const remarkGithub = (await import("remark-github")).default;
@ -93,7 +94,7 @@ module.exports = async function (): Promise<Config> {
{
docs: {
id: "docs",
sidebarPath: require.resolve("./sidebars.js"),
sidebarPath: "./sidebars.js",
editUrl:
"https://github.com/goauthentik/authentik/edit/main/website/",
remarkPlugins: [
@ -117,17 +118,6 @@ module.exports = async function (): Promise<Config> {
},
} satisfies Preset.Options,
],
[
"redocusaurus",
{
specs: [
{
id: "main",
spec: "static/schema.yaml",
},
],
},
],
],
plugins: [
[
@ -136,7 +126,7 @@ module.exports = async function (): Promise<Config> {
id: "docsIntegrations",
path: "integrations",
routeBasePath: "integrations",
sidebarPath: require.resolve("./sidebarsIntegrations.js"),
sidebarPath: "./sidebarsIntegrations.js",
editUrl:
"https://github.com/goauthentik/authentik/edit/main/website/",
},
@ -147,15 +137,33 @@ module.exports = async function (): Promise<Config> {
id: "docsDevelopers",
path: "developer-docs",
routeBasePath: "developer-docs",
sidebarPath: require.resolve("./sidebarsDev.js"),
sidebarPath: "./sidebarsDev.js",
docItemComponent: "@theme/ApiItem",
editUrl:
"https://github.com/goauthentik/authentik/edit/main/website/",
},
],
[
"docusaurus-plugin-openapi-docs",
{
id: "api",
docsPluginId: "docsDevelopers",
config: {
authentik: {
specPath: "static/schema.yaml",
outputDir: "developer-docs/api/reference/",
hideSendButton: true,
sidebarOptions: {
groupPathsBy: "tag",
},
} satisfies OpenApiPlugin.Options,
},
},
],
],
markdown: {
mermaid: true,
},
themes: ["@docusaurus/theme-mermaid"],
themes: ["docusaurus-theme-openapi-docs"],
};
};