Skip to content

fix(typography): correct heading "sizes", start with h1 and don't skip any #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
adrianschmidt wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix(typography): correct heading "sizes", start with h1 and don't skip any #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions src/components/component/templates/events.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ export function EventList({
}

return [
<h3 class="docs-layout-section-heading" id={id}>
<h2 class="docs-layout-section-heading" id={id}>
Events
</h3>,
</h2>,
...events.map(renderEvent),
];
}
Expand All @@ -43,7 +43,7 @@ function renderEvent(event: JsonDocsEvent) {

return (
<div class="props-events-layout">
<h4>{event.event}</h4>
<h3>{event.event}</h3>
<kompendium-taglist tags={event.docsTags} />
<div class="markdown-props">
<kompendium-markdown text={event.docs} />
Expand Down
4 changes: 2 additions & 2 deletions src/components/component/templates/examples.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ export function ExampleList({
}

return [
<h3 class="docs-layout-section-heading" id={id}>
<h2 class="docs-layout-section-heading" id={id}>
Examples
</h3>,
</h2>,
examples.map(renderExample(schema)),
];
}
Expand Down
12 changes: 6 additions & 6 deletions src/components/component/templates/methods.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ export function MethodList({
}

return [
<h3 class="docs-layout-section-heading" id={id}>
<h2 class="docs-layout-section-heading" id={id}>
Methods
</h3>,
</h2>,
...methods.map(renderMethod),
];
}
Expand All @@ -36,7 +36,7 @@ function renderMethod(method: JsonDocsMethod) {

return (
<div class="methods-layout">
<h4 class="methods-title">{method.name}</h4>
<h3 class="methods-title">{method.name}</h3>
<div class="methods-content">
<div>
<kompendium-markdown text={method.docs} />
Expand All @@ -59,7 +59,7 @@ function ParamList({ params }: { params: JsonDocMethodParameter[] }) {
return;
}

return [<h5>Parameters</h5>, ...params.map(renderParam)];
return [<h4>Parameters</h4>, ...params.map(renderParam)];
}

function renderParam(param: ParameterDescription) {
Expand All @@ -80,7 +80,7 @@ function renderParam(param: ParameterDescription) {

return (
<div>
<h6>{param.name}</h6>
<h5>{param.name}</h5>
<kompendium-markdown text={param.docs} />
<kompendium-proplist items={items} />
</div>
Expand All @@ -95,7 +95,7 @@ function Returns({ value }: { value: JsonDocsMethodReturn }) {
const type = '`' + value.type + '`';

return [
<h5>Returns</h5>,
<h4>Returns</h4>,
<kompendium-markdown text={value.docs} />,
<kompendium-markdown text={type} />,
];
Expand Down
6 changes: 3 additions & 3 deletions src/components/component/templates/props.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ export function PropertyList({
}

return [
<h3 class="docs-layout-section-heading" id={id}>
<h2 class="docs-layout-section-heading" id={id}>
Properties
</h3>,
</h2>,
...props.map(renderProperty),
];
}
Expand Down Expand Up @@ -47,7 +47,7 @@ function renderProperty(property: JsonDocsProp) {

return (
<div class="props-events-layout">
<h4>{property.name}</h4>
<h3>{property.name}</h3>
<kompendium-taglist tags={property.docsTags} />
<div class="markdown-props">
<kompendium-markdown text={property.docs} />
Expand Down
6 changes: 3 additions & 3 deletions src/components/component/templates/slots.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ export function SlotList({
}

return [
<h3 class="docs-layout-section-heading" id={id}>
<h2 class="docs-layout-section-heading" id={id}>
Slots
</h3>,
</h2>,
...slots.map(renderSlot),
];
}

function renderSlot(slot: JsonDocsSlot) {
return (
<div>
<h4>{slot.name}</h4>
<h3>{slot.name}</h3>
<kompendium-markdown text={slot.docs} />
</div>
);
Expand Down
4 changes: 2 additions & 2 deletions src/components/component/templates/style.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ export function StyleList({
}

return [
<h3 class="docs-layout-section-heading" id={id}>
<h2 class="docs-layout-section-heading" id={id}>
Styles
</h3>,
</h2>,
...styles.map(renderStyle),
];
}
Expand Down
4 changes: 2 additions & 2 deletions src/components/type/templates/enum.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ function MemberList({ members }: { members: EnumMember[] }): HTMLElement[] {
return;
}

return [<h3>Members</h3>, ...members.map(renderMember)];
return [<h2>Members</h2>, ...members.map(renderMember)];
}

function renderMember(member: EnumMember) {
Expand All @@ -29,7 +29,7 @@ function renderMember(member: EnumMember) {

return (
<div>
<h4>{member.name}</h4>
<h3>{member.name}</h3>
<kompendium-markdown text={member.docs} />
<kompendium-taglist tags={member.docsTags} />
<kompendium-proplist items={items} />
Expand Down