Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-09-20 18:58:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* fix: use h2/h3 for headings instead of h1/h2 for better seo

* fix: fixed e2e tests for changed headings

---------

Co-authored-by: Max Krumpe <max.krumpe@uniserv.com>
This commit is contained in:
Max Krumpe 2024-04-25 11:46:12 +02:00 committed by GitHub
parent ff91768879
commit 2b72dc0e90
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
e2e/integration/menu.e2e.ts
View File

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

4
src/components/ContentItems/ContentItems.tsx
View File

@ -3,7 +3,7 @@ import * as React from 'react';
import { ExternalDocumentation } from '../ExternalDocumentation/ExternalDocumentation'; import { ExternalDocumentation } from '../ExternalDocumentation/ExternalDocumentation';
import { AdvancedMarkdown } from '../Markdown/AdvancedMarkdown'; 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 { ContentItemModel } from '../../services';
import type { GroupModel, OperationModel } from '../../services/models'; import type { GroupModel, OperationModel } from '../../services/models';
import { Operation } from '../Operation/Operation'; import { Operation } from '../Operation/Operation';
@ -68,7 +68,7 @@ export class SectionItem extends React.Component<ContentItemProps> {
render() { render() {
const { name, description, externalDocs, level } = this.props.item as GroupModel; const { name, description, externalDocs, level } = this.props.item as GroupModel;
const Header = level === 2 ? H2 : H1; const Header = level === 2 ? H3 : H2;
return ( return (
<> <>
<Row> <Row>