FilesExpand file tree

main

/

structured-data.tsx

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

92 lines (87 loc) · 2.11 KB

main

/

structured-data.tsx

Copy path

Top

File metadata and controls

• Code
• Blame

92 lines (87 loc) · 2.11 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

import { serializeJsonLd } from '@/lib/json-ld'

import { DOCS_BASE_URL, SIM_SITE_URL } from '@/lib/urls'

interface StructuredDataProps {

title: string

description: string

url: string

dateModified?: string

breadcrumb?: Array<{ name: string; url: string }>

}

export function StructuredData({

title,

description,

url,

dateModified,

breadcrumb,

}: StructuredDataProps) {

const baseUrl = DOCS_BASE_URL

const structuredDataId = encodeURIComponent(url)

const articleStructuredData = {

'@context': 'https://schema.org',

'@type': 'TechArticle',

headline: title,

description: description,

url: url,

...(dateModified && { dateModified }),

author: {

'@type': 'Organization',

'@id': `${SIM_SITE_URL}#organization`,

name: 'Sim',

url: SIM_SITE_URL,

},

publisher: {

'@type': 'Organization',

'@id': `${SIM_SITE_URL}#organization`,

name: 'Sim',

url: SIM_SITE_URL,

logo: {

'@type': 'ImageObject',

url: `${baseUrl}/static/logo.png`,

},

},

mainEntityOfPage: {

'@type': 'WebPage',

'@id': url,

},

inLanguage: 'en',

isPartOf: {

'@type': 'WebSite',

name: 'Sim Documentation',

url: baseUrl,

},

potentialAction: {

'@type': 'ReadAction',

target: url,

},

}

const breadcrumbStructuredData = breadcrumb && {

'@context': 'https://schema.org',

'@type': 'BreadcrumbList',

itemListElement: breadcrumb.map((item, index) => ({

'@type': 'ListItem',

position: index + 1,

name: item.name,

item: item.url,

})),

}

return (

<>

<script

id={`article-json-ld-${structuredDataId}`}

type='application/ld+json'

dangerouslySetInnerHTML={{

__html: serializeJsonLd(articleStructuredData),

}}

/>

{breadcrumbStructuredData && (

<script

id={`breadcrumb-json-ld-${structuredDataId}`}

type='application/ld+json'

dangerouslySetInnerHTML={{

__html: serializeJsonLd(breadcrumbStructuredData),

}}

/>

)}

</>

)

}