Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,18 @@ export default config;

The package ships Base Nova tokens, fonts, preflight, animations, and compiled theme CSS. Consumer Tailwind/Sass config is neither required nor read.

## Container width

The navbar, docs content, footer, OpenAPI layout, and large dialogs share a `90rem` maximum width by default. Set one theme option to use a narrower or wider constant:

```ts
themes: [
["@aeei/docusaurus-theme", { containerMaxWidth: "80rem" }],
],
```

Positive `px`/`rem` strings are accepted. Numbers are interpreted as pixels.

## Search

Search is disabled by default.
Expand Down Expand Up @@ -172,7 +184,7 @@ Requirements:
Consumers then install a pinned release:

```bash
npm install @aeei/docusaurus-theme@0.1.10
npm install @aeei/docusaurus-theme@0.1.11
```

This repository does not publish automatically from an unapproved working tree.
Expand Down
2 changes: 1 addition & 1 deletion UPSTREAM.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ This repository is a maintained fork of [`PaloAltoNetworks/docusaurus-openapi-do

- Last integrated upstream release: `v5.1.3`
- Upstream baseline commit: `d5af4f22e951712e084df8b7c513a1708e56d372`
- Current AEEI theme release: `0.1.10`
- Current AEEI theme release: `0.1.11`
2 changes: 1 addition & 1 deletion demo/customMdGenerators.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export function myCustomApiMdGenerator({
`import RequestSchema from "@theme/RequestSchema";\n`,
`import StatusCodes from "@theme/StatusCodes";\n`,
`import OperationTabs from "@theme/OperationTabs";\n`,
`import TabItem from "@theme/TabItem";\n`,
`import TabItem from "@theme/ApiTabItem";\n`,
`import Heading from "@theme/Heading";\n`,
`import Translate from "@docusaurus/Translate";\n\n`,
createHeading(title),
Expand Down
2 changes: 2 additions & 0 deletions demo/docs/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,8 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following

> You may optionally configure a `sidebarOptions`. In doing so, an individual `sidebar.js` slice with the configured options will be generated within the respective `outputDir`.

### versions

`versions` can be configured with the following options:

| Name | Type | Default | Description |
Expand Down
25 changes: 9 additions & 16 deletions demo/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ const config: Config = {
respectPrefersColorScheme: true,
},
navbar: {
title: "OpenAPI Docs",
logo: {
alt: "OpenAPI Docs",
src: "img/docusaurus-openapi-docs-logo.svg",
Expand Down Expand Up @@ -96,15 +97,13 @@ const config: Config = {
{ type: "custom-PalettePicker", position: "right" },
{
href: "https://medium.com/palo-alto-networks-developer-blog",
label: "Blog",
position: "right",
className: "header-medium-link",
"aria-label": "Palo Alto Networks Developer Blog",
},
{
href: "https://github.com/PaloAltoNetworks/docusaurus-openapi-docs",
label: "GitHub",
position: "right",
className: "header-github-link",
"aria-label": "GitHub repository",
},
],
},
Expand Down Expand Up @@ -262,11 +261,6 @@ const config: Config = {
logoClass: "rust",
},
],
algolia: {
apiKey: "441074cace987cbf4640c039ebed303c",
appId: "J0EABTYI1A",
indexName: "docusaurus-openapi",
},
announcementBar: {
id: "announcementBar_2",
content: "v5.0.0 is now available! Requires Docusaurus 3.10.0+",
Expand Down Expand Up @@ -387,7 +381,6 @@ const config: Config = {
} satisfies Plugin.PluginOptions,
},
],
// FOUC prevention: restore saved palette before React hydrates
function paletteScript() {
return {
name: "palette-fouc-script",
Expand All @@ -404,12 +397,12 @@ const config: Config = {
};
},
],
themes: ["docusaurus-theme-openapi-docs"],
stylesheets: [
{
href: "https://use.fontawesome.com/releases/v5.11.0/css/all.css",
type: "text/css",
},
themes: [
"docusaurus-theme-openapi-docs",
[
"@aeei/docusaurus-theme",
{ search: "local", copyPage: true, containerMaxWidth: "90rem" },
],
],
};

Expand Down
4 changes: 3 additions & 1 deletion demo/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"clean-api-docs": "docusaurus clean-api-docs",
"gen-api-docs:version": "docusaurus gen-api-docs:version",
"clean-api-docs:version": "docusaurus clean-api-docs:version",
"gen-all": "docusaurus gen-api-docs all --all-versions",
"gen-all": "docusaurus clean-api-docs all --all-versions && docusaurus gen-api-docs all --all-versions",
"clean-all": "docusaurus clean-api-docs all --all-versions",
"re-gen": "yarn clean-all-versions && yarn gen-all-versions"
},
Expand All @@ -25,9 +25,11 @@
"@docusaurus/faster": "3.10.2",
"@docusaurus/plugin-google-gtag": "3.10.2",
"@docusaurus/preset-classic": "3.10.2",
"@aeei/docusaurus-theme": "*",
"clsx": "^2.1.1",
"docusaurus-plugin-openapi-docs": "*",
"docusaurus-theme-openapi-docs": "*",
"lucide-react": "^0.468.0",
"prism-react-renderer": "^2.3.0",
"react": "^19.0.0",
"react-dom": "^19.0.0"
Expand Down
Loading