Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-16 19:43:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix(website): show headers for type aliases (#9054)

Browse Source
This commit is contained in:
Suneet Tipirneni
2023-03-23 15:42:29 -04:00
committed by GitHub
parent 03f5f1e3b6
commit 091824abc5
6 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
apps/website/src/components/documentation/ObjectHeader.tsx
View File

@@ -1,10 +1,10 @@
import type { ApiDeclaredItem, ApiItemContainerMixin } from '@microsoft/api-extractor-model'; import type { ApiDeclaredItem } from '@microsoft/api-extractor-model';
import { SyntaxHighlighter } from '../SyntaxHighlighter'; import { SyntaxHighlighter } from '../SyntaxHighlighter';
import { Header } from './Header'; import { Header } from './Header';
import { SummarySection } from './section/SummarySection'; import { SummarySection } from './section/SummarySection';
export interface ObjectHeaderProps { export interface ObjectHeaderProps {
item: ApiDeclaredItem & ApiItemContainerMixin; item: ApiDeclaredItem;
} }
export function ObjectHeader({ item }: ObjectHeaderProps) { export function ObjectHeader({ item }: ObjectHeaderProps) {

4
apps/website/src/components/model/TypeAlias.tsx
View File

@@ -1,11 +1,13 @@
import type { ApiTypeAlias } from '@microsoft/api-extractor-model'; import type { ApiTypeAlias } from '@microsoft/api-extractor-model';
import { SyntaxHighlighter } from '../SyntaxHighlighter'; import { SyntaxHighlighter } from '../SyntaxHighlighter';
import { Documentation } from '../documentation/Documentation'; import { Documentation } from '../documentation/Documentation';
import { Header } from '../documentation/Header';
import { SummarySection } from '../documentation/section/SummarySection'; import { SummarySection } from '../documentation/section/SummarySection';
export function TypeAlias({ item }: { item: ApiTypeAlias }) { export function TypeAlias({ item }: { item: ApiTypeAlias }) {
return ( return (
<Documentation item={item}> <Documentation>
<Header kind={item.kind} name={item.displayName} sourceURL={item.sourceLocation.fileUrl} />
<SyntaxHighlighter code={item.excerpt.text} /> <SyntaxHighlighter code={item.excerpt.text} />
<SummarySection item={item} /> <SummarySection item={item} />
</Documentation> </Documentation>

6
apps/website/src/components/model/Variable.tsx
View File

@@ -1,12 +1,12 @@
import type { ApiVariable } from '@microsoft/api-extractor-model'; import type { ApiVariable } from '@microsoft/api-extractor-model';
import { SyntaxHighlighter } from '../SyntaxHighlighter';
import { Documentation } from '../documentation/Documentation'; import { Documentation } from '../documentation/Documentation';
import { ObjectHeader } from '../documentation/ObjectHeader';
import { SummarySection } from '../documentation/section/SummarySection'; import { SummarySection } from '../documentation/section/SummarySection';
export function Variable({ item }: { item: ApiVariable }) { export function Variable({ item }: { item: ApiVariable }) {
return ( return (
<Documentation item={item}> <Documentation>
<SyntaxHighlighter code={item.excerpt.text} /> <ObjectHeader item={item} />
<SummarySection item={item} /> <SummarySection item={item} />
</Documentation> </Documentation>
); );

6
apps/website/src/components/model/enum/Enum.tsx
View File

@@ -3,14 +3,14 @@ import { VscSymbolEnum } from '@react-icons/all-files/vsc/VscSymbolEnum';
import { Documentation } from '../../documentation/Documentation'; import { Documentation } from '../../documentation/Documentation';
import { EnumMember } from './EnumMember'; import { EnumMember } from './EnumMember';
import { Panel } from '~/components/Panel'; import { Panel } from '~/components/Panel';
import { SyntaxHighlighter } from '~/components/SyntaxHighlighter'; import { ObjectHeader } from '~/components/documentation/ObjectHeader';
import { ResponsiveSection } from '~/components/documentation/section/ResponsiveSection'; import { ResponsiveSection } from '~/components/documentation/section/ResponsiveSection';
import { SummarySection } from '~/components/documentation/section/SummarySection'; import { SummarySection } from '~/components/documentation/section/SummarySection';
export function Enum({ item }: { item: ApiEnum }) { export function Enum({ item }: { item: ApiEnum }) {
return ( return (
<Documentation item={item}> <Documentation>
<SyntaxHighlighter code={item.excerpt.text} /> <ObjectHeader item={item} />
<SummarySection item={item} /> <SummarySection item={item} />
<ResponsiveSection icon={<VscSymbolEnum size={20} />} padded title="Members"> <ResponsiveSection icon={<VscSymbolEnum size={20} />} padded title="Members">
<div className="flex flex-col gap-4"> <div className="flex flex-col gap-4">

2
apps/website/src/pages/api/og.tsx
View File

@@ -40,5 +40,5 @@ export default async function handler() {
} }
export const config = { export const config = {
runtime: 'edge', runtime: 'experimental-edge',
}; };

2
apps/website/src/pages/api/og_model.tsx
View File

@@ -166,5 +166,5 @@ export default async function handler(req: NextRequest) {
} }
export const config = { export const config = {
runtime: 'edge', runtime: 'experimental-edge',
}; };