Spaces:
Paused
Paused
| /** | |
| * Licensed to the Apache Software Foundation (ASF) under one | |
| * or more contributor license agreements. See the NOTICE file | |
| * distributed with this work for additional information | |
| * regarding copyright ownership. The ASF licenses this file | |
| * to you under the Apache License, Version 2.0 (the | |
| * "License"); you may not use this file except in compliance | |
| * with the License. You may obtain a copy of the License at | |
| * | |
| * http://www.apache.org/licenses/LICENSE-2.0 | |
| * | |
| * Unless required by applicable law or agreed to in writing, | |
| * software distributed under the License is distributed on an | |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| * KIND, either express or implied. See the License for the | |
| * specific language governing permissions and limitations | |
| * under the License. | |
| */ | |
| import type { JSX } from 'react'; | |
| import Head from '@docusaurus/Head'; | |
| interface FAQItem { | |
| question: string; | |
| answer: string; | |
| } | |
| interface FAQSchemaProps { | |
| faqs: FAQItem[]; | |
| } | |
| /** | |
| * Component that injects FAQPage JSON-LD structured data | |
| * Use this on FAQ pages to enable rich snippets in search results | |
| * | |
| * @example | |
| * <FAQSchema faqs={[ | |
| * { question: "What is Superset?", answer: "Apache Superset is..." }, | |
| * { question: "How do I install it?", answer: "You can install via..." } | |
| * ]} /> | |
| */ | |
| export default function FAQSchema({ | |
| faqs, | |
| }: FAQSchemaProps): JSX.Element | null { | |
| // FAQPage schema requires a non-empty mainEntity array per schema.org specs | |
| if (!faqs || faqs.length === 0) { | |
| return null; | |
| } | |
| const schema = { | |
| '@context': 'https://schema.org', | |
| '@type': 'FAQPage', | |
| mainEntity: faqs.map(faq => ({ | |
| '@type': 'Question', | |
| name: faq.question, | |
| acceptedAnswer: { | |
| '@type': 'Answer', | |
| text: faq.answer, | |
| }, | |
| })), | |
| }; | |
| return ( | |
| <Head> | |
| <script type="application/ld+json">{JSON.stringify(schema)}</script> | |
| </Head> | |
| ); | |
| } | |