Skip to content
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

Jump to bottom

fix: use h2/h3 for headings instead of h1/h2 for better seo #2514

Merged
merged 4 commits into from
Apr 25, 2024
Merged

fix: use h2/h3 for headings instead of h1/h2 for better seo #2514

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
840b2cb
fix: use h2/h3 for headings instead of h1/h2 for better seo
mxkrmp Apr 17, 2024
377a5bc
Merge branch 'Redocly:main' into main
maxkrumpe Apr 25, 2024
54869d7
fix: fixed e2e tests for changed headings
mxkrmp Apr 25, 2024
b4b1f10
Merge remote-tracking branch 'origin/main' into main
mxkrmp Apr 25, 2024
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
4 changes: 2 additions & 2 deletions e2e/integration/menu.e2e.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ describe('Menu', () => {
});

it('should sync active menu items while scroll', () => {
cy.contains('h1', 'Introduction')
cy.contains('h2', 'Introduction')
.scrollIntoView()
.get('[role=menuitem] > label.active')
.should('have.text', 'Introduction');
Expand All @@ -35,7 +35,7 @@ describe('Menu', () => {

cy.contains('h1', 'Swagger Petstore').scrollIntoView().wait(100);

cy.contains('h1', 'Introduction')
cy.contains('h2', 'Introduction')
.scrollIntoView()
.wait(100)
.get('[role=menuitem] > label.active')
Expand Down
4 changes: 2 additions & 2 deletions src/components/ContentItems/ContentItems.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import * as React from 'react';

import { ExternalDocumentation } from '../ExternalDocumentation/ExternalDocumentation';
import { AdvancedMarkdown } from '../Markdown/AdvancedMarkdown';
import { H1, H2, MiddlePanel, Row, Section, ShareLink } from '../../common-elements';
import { H2, H3, MiddlePanel, Row, Section, ShareLink } from '../../common-elements';
import type { ContentItemModel } from '../../services';
import type { GroupModel, OperationModel } from '../../services/models';
import { Operation } from '../Operation/Operation';
Expand Down Expand Up @@ -68,7 +68,7 @@ export class SectionItem extends React.Component<ContentItemProps> {
render() {
const { name, description, externalDocs, level } = this.props.item as GroupModel;

const Header = level === 2 ? H2 : H1;
const Header = level === 2 ? H3 : H2;
return (
<>
<Row>
Expand Down
Loading