Skip to content
Closed
Changes from 1 commit
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
442f5d5
Add mustache package
sserrata Apr 12, 2022
c8c6fbd
Remove docs modules
sserrata Apr 12, 2022
bfb2fda
Remove sidebars modules
sserrata Apr 12, 2022
27738df
Refactor openapi module
sserrata Apr 12, 2022
e66f5fb
Cleanup options and unused types/packages; introduce outputDir and te…
sserrata Apr 12, 2022
66be8af
Extend docs types and remove unused types
sserrata Apr 12, 2022
d9c4e66
Declare plugin-content-docs-types module
sserrata Apr 12, 2022
ae7a81c
Cleanup remark-admonitions module declaration
sserrata Apr 12, 2022
a4d95ac
Cleanup plugin options and update ApiPageMetadata
sserrata Apr 12, 2022
7659373
Refactor plugin to emit mdx
sserrata Apr 12, 2022
8a02d9f
Fix @paloaltonetworks/docusaurus-theme-openapi import
sserrata Apr 12, 2022
e5d67af
Refactor plugin to write mdx files to plugin-content-docs path
sserrata Apr 12, 2022
fdf081a
Refactor to support new plugin
sserrata Apr 12, 2022
868c83f
Add @docusaurus/plugin-content-docs-types declaration
sserrata Apr 12, 2022
f324a05
Comment out VSCode to avoid cross-origin errors
sserrata Apr 12, 2022
f1e3b9b
Add @ts-ignore as workaround
sserrata Apr 12, 2022
c63cb6d
Remove ApiPage component
sserrata Apr 12, 2022
79a2ca0
Refactor to support additional plugin-content-docs features
sserrata Apr 12, 2022
a836a28
Update yarn.lock
sserrata Apr 12, 2022
a90af10
Comment out unused imports/vars
sserrata Apr 12, 2022
7492f5b
Add API md/mdx files to gitignore
sserrata Apr 13, 2022
10673b3
Generate md/mdx before loadContent() life cycle method
sserrata Apr 13, 2022
cf144b1
Rename cos and routeBasePath
sserrata Apr 13, 2022
dc311ff
Update cypress tests
sserrata Apr 13, 2022
df14045
Fix navbar links
sserrata Apr 13, 2022
3e94e4d
Cleanup apiSidebars
sserrata Apr 13, 2022
2c15ca9
Update gitignore
sserrata Apr 13, 2022
7c998af
Add cleanApiDocs script
sserrata Apr 13, 2022
04b4060
Rename info doc to index.mdx
sserrata Apr 13, 2022
ac3acab
Render TOC for all non-api docs
sserrata Apr 13, 2022
9906e5d
Add non-API doc examples
sserrata Apr 13, 2022
ccb9d53
Remove examples
sserrata Apr 13, 2022
45d5a90
Add sidebar_class_name to mustache template
sserrata Apr 13, 2022
6acca1e
Fix heading level in info description to allow TOC
sserrata Apr 13, 2022
340d83f
Hide TOC for api docs
sserrata Apr 13, 2022
594d766
Respect hideTableOfContents
sserrata Apr 13, 2022
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
Prev Previous commit
Next Next commit
Declare plugin-content-docs-types module
  • Loading branch information
sserrata committed Apr 12, 2022
commit d9c4e66f7e9a641b9f8827009e409d6652b7fafc
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/* ============================================================================
* Copyright (c) Cloud Annotations
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
* ========================================================================== */

declare module "@docusaurus/plugin-content-docs-types" {
// Makes all properties visible when hovering over the type
type Expand<T extends Record<string, unknown>> = { [P in keyof T]: T[P] };

export type SidebarItemBase = {
className?: string;
customProps?: Record<string, unknown>;
};

export type SidebarItemLink = SidebarItemBase & {
type: "link";
href: string;
label: string;
docId: string;
};

type SidebarItemCategoryBase = SidebarItemBase & {
type: "category";
label: string;
collapsed: boolean;
collapsible: boolean;
};

export type PropSidebarItemCategory = Expand<
SidebarItemCategoryBase & {
items: PropSidebarItem[];
}
>;

export type PropSidebarItem = SidebarItemLink | PropSidebarItemCategory;
export type PropSidebar = PropSidebarItem[];
export type PropSidebars = {
[sidebarId: string]: PropSidebar;
};
}