diff --git a/packages/website/src/DocModel/DocInterface.ts b/packages/website/src/DocModel/DocInterface.ts index e134a9939..f2b76a6af 100644 --- a/packages/website/src/DocModel/DocInterface.ts +++ b/packages/website/src/DocModel/DocInterface.ts @@ -2,7 +2,13 @@ import { DocItem } from './DocItem'; import { DocMethodSignature } from './DocMethodSignature'; import { DocProperty } from './DocProperty'; import { TypeParameterMixin } from './TypeParameterMixin'; -import { ApiInterface, ApiItemKind, ApiMethodSignature, ApiModel, ApiPropertySignature } from '~/api-extractor.server'; +import { + ApiInterface, + ApiItemKind, + ApiMethodSignature, + ApiModel, + ApiPropertySignature, +} from '~/util/api-extractor.server'; import { type TokenDocumentation, genToken } from '~/util/parse.server'; export class DocInterface extends TypeParameterMixin(DocItem) { diff --git a/packages/website/src/DocModel/DocItem.ts b/packages/website/src/DocModel/DocItem.ts index 3d4374c1c..c4505595d 100644 --- a/packages/website/src/DocModel/DocItem.ts +++ b/packages/website/src/DocModel/DocItem.ts @@ -1,5 +1,5 @@ import type { ApiModel, ApiDeclaredItem } from '@microsoft/api-extractor-model'; -import type { ReferenceData } from '~/model.server'; +import type { ReferenceData } from '~/util/model.server'; import { resolveName, genReference, resolveDocComment, TokenDocumentation, genToken } from '~/util/parse.server'; export type DocItemConstructor = new (...args: any[]) => T; diff --git a/packages/website/src/components/CodeListing.tsx b/packages/website/src/components/CodeListing.tsx index 7fd443f91..ed17c12fa 100644 --- a/packages/website/src/components/CodeListing.tsx +++ b/packages/website/src/components/CodeListing.tsx @@ -26,15 +26,15 @@ export function CodeListing({ }: CodeListingProps) { return (
-
-
-

{`${name}`}

-

{separator}

-

+
+
+

{`${name}`}

+

{separator}

+

- {summary &&

{summary}

} + {summary &&

{summary}

} {children}

diff --git a/packages/website/src/components/DocContainer.tsx b/packages/website/src/components/DocContainer.tsx index f0ed0afc9..d2e380fb0 100644 --- a/packages/website/src/components/DocContainer.tsx +++ b/packages/website/src/components/DocContainer.tsx @@ -1,6 +1,7 @@ import type { ReactNode } from 'react'; import { PrismAsyncLight as SyntaxHighlighter } from 'react-syntax-highlighter'; import { vscDarkPlus } from 'react-syntax-highlighter/dist/cjs/styles/prism'; +import { CodeListingSeparatorType } from './CodeListing'; import { HyperlinkedText } from './HyperlinkedText'; import { Section } from './Section'; import { TypeParamTable } from './TypeParamTable'; @@ -21,27 +22,26 @@ export function DocContainer({ name, kind, excerpt, summary, typeParams, childre return ( <>
-

- {generateIcon(kind, 'mr-2')} +

+ {generateIcon(kind)} {name}

-
- - {excerpt} - -
+ + {excerpt} + {extendsTokens?.length ? ( -
-

Extends

+
+

Extends:

+

{CodeListingSeparatorType.Type}

@@ -49,11 +49,11 @@ export function DocContainer({ name, kind, excerpt, summary, typeParams, childre ) : null}
-

{summary ?? 'No summary provided.'}

+

{summary ?? 'No summary provided.'}

{typeParams?.length ? (
- +
) : null}
{children}
diff --git a/packages/website/src/components/HyperlinkedText.tsx b/packages/website/src/components/HyperlinkedText.tsx index 7c9050499..9116ed5fe 100644 --- a/packages/website/src/components/HyperlinkedText.tsx +++ b/packages/website/src/components/HyperlinkedText.tsx @@ -19,12 +19,16 @@ export function HyperlinkedText({ tokens }: HyperlinkedTextProps) { if (token.path) { return ( - {token.text} + {token.text} ); } - return token.text; + return ( + + {token.text} + + ); })} ); diff --git a/packages/website/src/components/ItemSidebar.tsx b/packages/website/src/components/ItemSidebar.tsx index 40d8e4dae..fe704499a 100644 --- a/packages/website/src/components/ItemSidebar.tsx +++ b/packages/website/src/components/ItemSidebar.tsx @@ -19,30 +19,30 @@ function onMenuClick() { export function ItemSidebar({ packageName, data, selectedMember }: ItemListProps) { return ( -
-
-

- +
+
+

+ {`${packageName}`}

-
+
{data.members.map((member, i) => ( - diff --git a/packages/website/src/components/MethodItem.tsx b/packages/website/src/components/MethodItem.tsx index 343db3e1d..e542ce4a8 100644 --- a/packages/website/src/components/MethodItem.tsx +++ b/packages/website/src/components/MethodItem.tsx @@ -28,23 +28,23 @@ function onAnchorClick() { export function MethodItem({ data }: MethodItemProps) { return (
-
+
-
-
-

{`${getShorthandName(data)}`}

-

:

-

+
+
+

{`${getShorthandName(data)}`}

+

:

+

-
- {data.summary &&

{data.summary}

} - {data.parameters.length ? : null} +
+ {data.summary &&

{data.summary}

} + {data.parameters.length ? : null}
); diff --git a/packages/website/src/components/MethodList.tsx b/packages/website/src/components/MethodList.tsx index 55297261d..7448d3277 100644 --- a/packages/website/src/components/MethodList.tsx +++ b/packages/website/src/components/MethodList.tsx @@ -9,7 +9,7 @@ export interface MethodListProps { export function MethodList({ data }: MethodListProps) { return (
-
+
{data.map((method) => ( ))} diff --git a/packages/website/src/components/PropertyList.tsx b/packages/website/src/components/PropertyList.tsx index e60b77771..97dec58ee 100644 --- a/packages/website/src/components/PropertyList.tsx +++ b/packages/website/src/components/PropertyList.tsx @@ -7,7 +7,7 @@ export interface PropertyListProps { export function PropertyList({ data }: PropertyListProps) { return ( -
+
{data.map((prop) => ( ))} diff --git a/packages/website/src/components/Section.tsx b/packages/website/src/components/Section.tsx index a2b63b01e..09a9ce94b 100644 --- a/packages/website/src/components/Section.tsx +++ b/packages/website/src/components/Section.tsx @@ -16,29 +16,36 @@ export function Section({ title, children, className, defaultClosed }: SectionPr return (
-

+

setCollapsed(!collapsed)}> - {collapsed ? : } + {collapsed ? : }
- {title}

- {!collapsed && ( - -
{children}
-
+ {collapsed ? null : ( + <> + + {children} + + + )} -
); diff --git a/packages/website/src/components/Seperator.tsx b/packages/website/src/components/Seperator.tsx index 7b43af0fb..02cc2802c 100644 --- a/packages/website/src/components/Seperator.tsx +++ b/packages/website/src/components/Seperator.tsx @@ -1,3 +1,3 @@ export function Separator() { - return
; + return
; } diff --git a/packages/website/src/components/SidebarLayout.tsx b/packages/website/src/components/SidebarLayout.tsx index 2c2f4d91f..fd500cb7c 100644 --- a/packages/website/src/components/SidebarLayout.tsx +++ b/packages/website/src/components/SidebarLayout.tsx @@ -1,6 +1,6 @@ import type { PropsWithChildren } from 'react'; import { type ItemListProps, ItemSidebar } from './ItemSidebar'; -import type { findMember } from '~/model.server'; +import type { findMember } from '~/util/model.server'; export function SidebarLayout({ packageName, diff --git a/packages/website/src/components/Table.tsx b/packages/website/src/components/Table.tsx index cb25a5aef..ca30ce03a 100644 --- a/packages/website/src/components/Table.tsx +++ b/packages/website/src/components/Table.tsx @@ -19,7 +19,7 @@ export function Table({ rows, columns, columnStyles, className }: TableProps) { {columns.map((column) => ( - + {column} ))} @@ -31,9 +31,7 @@ export function Table({ rows, columns, columnStyles, className }: TableProps) { {Object.entries(row).map(([colName, val]) => ( {val} diff --git a/packages/website/src/pages/docs/[...slug].tsx b/packages/website/src/pages/docs/[...slug].tsx index a28511a59..c6630c032 100644 --- a/packages/website/src/pages/docs/[...slug].tsx +++ b/packages/website/src/pages/docs/[...slug].tsx @@ -14,12 +14,12 @@ import { Function } from '~/components/model/Function'; import { Interface } from '~/components/model/Interface'; import { TypeAlias } from '~/components/model/TypeAlias'; import { Variable } from '~/components/model/Variable'; -import { findMember } from '~/model.server'; import { createApiModel } from '~/util/api-model.server'; +import { findMember } from '~/util/model.server'; import { findPackage, getMembers } from '~/util/parse.server'; export const getStaticPaths: GetStaticPaths = async () => { - const packages = ['builders', 'collection', 'proxy', 'rest', 'voice']; + const packages = ['builders', 'collection', 'proxy', 'rest', 'voice', 'ws']; const pkgs = ( await Promise.all( diff --git a/packages/website/src/pages/index.tsx b/packages/website/src/pages/index.tsx index 091b38606..6d584b003 100644 --- a/packages/website/src/pages/index.tsx +++ b/packages/website/src/pages/index.tsx @@ -23,8 +23,8 @@ const LinkButton = forwardRef(({ title, onClick, export default function IndexRoute() { return (
-
-
+
+
@@ -38,7 +38,7 @@ export default function IndexRoute() {

{text.heroTitle}

-

{text.heroDescription}

+

{text.heroDescription}

@@ -46,7 +46,7 @@ export default function IndexRoute() {
-
+
diff --git a/packages/website/src/api-extractor.server.ts b/packages/website/src/util/api-extractor.server.ts similarity index 100% rename from packages/website/src/api-extractor.server.ts rename to packages/website/src/util/api-extractor.server.ts diff --git a/packages/website/src/util/api-model.server.ts b/packages/website/src/util/api-model.server.ts index b764c8ae8..b7f9aa805 100644 --- a/packages/website/src/util/api-model.server.ts +++ b/packages/website/src/util/api-model.server.ts @@ -1,8 +1,8 @@ /* eslint-disable @typescript-eslint/no-unsafe-member-access */ /* eslint-disable @typescript-eslint/no-unsafe-assignment */ -import { ApiItem, ApiModel, ApiPackage } from '~/api-extractor.server'; -import { TSDocConfigFile } from '~/tsdoc-config.server'; -import { TSDocConfiguration } from '~/tsdoc.server'; +import { ApiItem, ApiModel, ApiPackage } from '~/util/api-extractor.server'; +import { TSDocConfigFile } from '~/util/tsdoc-config.server'; +import { TSDocConfiguration } from '~/util/tsdoc.server'; export function createApiModel(data: any) { const model = new ApiModel(); diff --git a/packages/website/src/util/icon.tsx b/packages/website/src/util/icon.tsx index 9cbd4ec04..f317c21e1 100644 --- a/packages/website/src/util/icon.tsx +++ b/packages/website/src/util/icon.tsx @@ -2,12 +2,12 @@ import { VscSymbolClass, VscSymbolMethod, VscSymbolEnum, VscSymbolInterface, Vsc export function generateIcon(kind: string, className?: string) { const icons = { - Class: , + Class: , Method: , Function: , Enum: , - Interface: , - TypeAlias: , + Interface: , + TypeAlias: , }; return icons[kind as keyof typeof icons]; diff --git a/packages/website/src/model.server.ts b/packages/website/src/util/model.server.ts similarity index 81% rename from packages/website/src/model.server.ts rename to packages/website/src/util/model.server.ts index 59b222246..9180b99f0 100644 --- a/packages/website/src/model.server.ts +++ b/packages/website/src/util/model.server.ts @@ -10,14 +10,14 @@ import { ApiTypeAlias, ApiVariable, } from '@microsoft/api-extractor-model'; -import { DocClass } from './DocModel/DocClass'; -import { DocEnum } from './DocModel/DocEnum'; -import { DocFunction } from './DocModel/DocFunction'; -import { DocInterface } from './DocModel/DocInterface'; -import { DocItem } from './DocModel/DocItem'; -import { DocTypeAlias } from './DocModel/DocTypeAlias'; -import { DocVariable } from './DocModel/DocVariable'; -import { findPackage } from './util/parse.server'; +import { findPackage } from './parse.server'; +import { DocClass } from '../DocModel/DocClass'; +import { DocEnum } from '../DocModel/DocEnum'; +import { DocFunction } from '../DocModel/DocFunction'; +import { DocInterface } from '../DocModel/DocInterface'; +import { DocItem } from '../DocModel/DocItem'; +import { DocTypeAlias } from '../DocModel/DocTypeAlias'; +import { DocVariable } from '../DocModel/DocVariable'; export interface ReferenceData { name: string; diff --git a/packages/website/src/tsdoc-config.server.ts b/packages/website/src/util/tsdoc-config.server.ts similarity index 100% rename from packages/website/src/tsdoc-config.server.ts rename to packages/website/src/util/tsdoc-config.server.ts diff --git a/packages/website/src/tsdoc.server.tsx b/packages/website/src/util/tsdoc.server.tsx similarity index 100% rename from packages/website/src/tsdoc.server.tsx rename to packages/website/src/util/tsdoc.server.tsx