Skip to content
Permalink
Browse files

docs(api): generate api docs

  • Loading branch information
ifiokjr committed Jan 9, 2020
1 parent ae2a2b6 commit 01b2907271afc3e971f3f5a8e2890a5baba0e002
@@ -0,0 +1,42 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [gatsby-plugin-next-seo](./gatsby-plugin-next-seo.md) &gt; [FAQJsonLd](./gatsby-plugin-next-seo.faqjsonld.md)

## FAQJsonLd variable

A Frequently Asked Question (FAQ) page contains a list of questions and answers pertaining to a particular topic.

<b>Signature:</b>

```typescript
FAQJsonLd: FC<FAQJsonLdProps>
```

## Remarks

Properly marked up FAQ pages may be eligible to have a rich result on Search and voice assistants.

```tsx
import React from 'react';
import { FAQJsonLd } from 'gatsby-plugin-next-seo';
export default () => (
<>
<FAQJsonLd mainEntity={[{ question: 'What?', answer: 'Stand' }, { question:
'How?', answer: 'Effort' }, { question: 'Why?', answer: 'Peace' },
]}
/>
<h1>What?</h1>
<p>Stand</p>
<h1>How?</h1>
<p>Effort</p>
<h1>Why?</h1>
<p>Peace</p>
</>
);
```

@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [gatsby-plugin-next-seo](./gatsby-plugin-next-seo.md) &gt; [FAQJsonLdProps](./gatsby-plugin-next-seo.faqjsonldprops.md)

## FAQJsonLdProps interface

The FAQPage JSON LD Component props.

<b>Signature:</b>

```typescript
export interface FAQJsonLdProps extends DeferSeoProps, Overrides<FAQPage>
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [questions](./gatsby-plugin-next-seo.faqjsonldprops.questions.md) | <code>Question[]</code> | An array of Question elements which comprise the list of answered questions that this FAQPage is about. |
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [gatsby-plugin-next-seo](./gatsby-plugin-next-seo.md) &gt; [FAQJsonLdProps](./gatsby-plugin-next-seo.faqjsonldprops.md) &gt; [questions](./gatsby-plugin-next-seo.faqjsonldprops.questions.md)

## FAQJsonLdProps.questions property

An array of Question elements which comprise the list of answered questions that this FAQPage is about.

<b>Signature:</b>

```typescript
questions: Question[];
```
@@ -20,6 +20,7 @@
| [CourseJsonLdProps](./gatsby-plugin-next-seo.coursejsonldprops.md) | The Course JSON LD Component props. |
| [DefaultSeoProps](./gatsby-plugin-next-seo.defaultseoprops.md) | |
| [DeferSeoProps](./gatsby-plugin-next-seo.deferseoprops.md) | |
| [FAQJsonLdProps](./gatsby-plugin-next-seo.faqjsonldprops.md) | The FAQPage JSON LD Component props. |
| [GatsbySeoPluginOptions](./gatsby-plugin-next-seo.gatsbyseopluginoptions.md) | |
| [GatsbySeoProps](./gatsby-plugin-next-seo.gatsbyseoprops.md) | |
| [ItemListElements](./gatsby-plugin-next-seo.itemlistelements.md) | |
@@ -36,6 +37,7 @@
| [OpenGraphVideoActors](./gatsby-plugin-next-seo.opengraphvideoactors.md) | |
| [OpenGraphVideos](./gatsby-plugin-next-seo.opengraphvideos.md) | |
| [ProductJsonLdProps](./gatsby-plugin-next-seo.productjsonldprops.md) | Component props for the Product JSON LD. |
| [Question](./gatsby-plugin-next-seo.question.md) | The questions and answers for an FAQ Page. |
| [SpeakableJsonLdProps](./gatsby-plugin-next-seo.speakablejsonldprops.md) | The Speakable JSON LD Component props. |
| [Twitter](./gatsby-plugin-next-seo.twitter.md) | |

@@ -51,6 +53,7 @@
| [BreadcrumbJsonLd](./gatsby-plugin-next-seo.breadcrumbjsonld.md) | A breadcrumb trail on a page indicates the page's position in the site hierarchy. A user can navigate all the way up in the site hierarchy, one level at a time, by starting from the last breadcrumb in the breadcrumb trail. |
| [CorporateContactJsonLd](./gatsby-plugin-next-seo.corporatecontactjsonld.md) | |
| [CourseJsonLd](./gatsby-plugin-next-seo.coursejsonld.md) | |
| [FAQJsonLd](./gatsby-plugin-next-seo.faqjsonld.md) | A Frequently Asked Question (FAQ) page contains a list of questions and answers pertaining to a particular topic. |
| [GatsbySeo](./gatsby-plugin-next-seo.gatsbyseo.md) | This component render the tags in the <code>&lt;head&gt;</code> for SEO on a per page basis. As a bare minimum, you should add a title and description. |
| [JsonLd](./gatsby-plugin-next-seo.jsonld.md) | Component that inline-includes a JSON-LD script where specified. |
| [LocalBusinessJsonLd](./gatsby-plugin-next-seo.localbusinessjsonld.md) | When users search for businesses on Google Search or Maps, Search results may display a prominent Knowledge Graph card with details about a business that matched the query. |
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [gatsby-plugin-next-seo](./gatsby-plugin-next-seo.md) &gt; [Question](./gatsby-plugin-next-seo.question.md) &gt; [answer](./gatsby-plugin-next-seo.question.answer.md)

## Question.answer property

The answer to the question. There must be one answer per question.

<b>Signature:</b>

```typescript
answer: string;
```

## Remarks

The answer may contain HTML content such as links and lists. Valid HTML tags include: &lt;<!-- -->h1<!-- -->&gt; through &lt;<!-- -->h6<!-- -->&gt;<!-- -->, <br>, <ol>, <ul>, <li>, <a>, <p>, <div>, <b>, <strong>, <i>, and <em>.

@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [gatsby-plugin-next-seo](./gatsby-plugin-next-seo.md) &gt; [Question](./gatsby-plugin-next-seo.question.md)

## Question interface

The questions and answers for an FAQ Page.

<b>Signature:</b>

```typescript
export interface Question
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [answer](./gatsby-plugin-next-seo.question.answer.md) | <code>string</code> | The answer to the question. There must be one answer per question. |
| [question](./gatsby-plugin-next-seo.question.question.md) | <code>string</code> | The full text of the question. For example, "How long does it take to process a refund?". |
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [gatsby-plugin-next-seo](./gatsby-plugin-next-seo.md) &gt; [Question](./gatsby-plugin-next-seo.question.md) &gt; [question](./gatsby-plugin-next-seo.question.question.md)

## Question.question property

The full text of the question. For example, "How long does it take to process a refund?".

<b>Signature:</b>

```typescript
question: string;
```
@@ -12,6 +12,7 @@ import { BreadcrumbList } from 'schema-dts';
import { Course } from 'schema-dts';
import { Date as Date_2 } from 'schema-dts';
import { Except } from 'type-fest';
import { FAQPage } from 'schema-dts';
import { FC } from 'react';
import { LiteralUnion } from 'type-fest';
import { LocalBusiness as LocalBusiness_2 } from 'schema-dts';
@@ -202,6 +203,14 @@ export interface DeferSeoProps {
defer?: boolean;
}
// @public
export const FAQJsonLd: FC<FAQJsonLdProps>;
// @public
export interface FAQJsonLdProps extends DeferSeoProps, Overrides<FAQPage> {
questions: Question[];
}
// @public
export const GatsbySeo: ({ metaTags, linkTags, canonical, description, facebook, languageAlternates, mobileAlternate, nofollow, noindex, openGraph, title, titleTemplate, twitter, }: GatsbySeoProps) => JSX.Element;
@@ -429,6 +438,12 @@ export interface ProductJsonLdProps extends DeferSeoProps, Overrides<Product> {
sku?: string | string[];
}
// @public
export interface Question {
answer: string;
question: string;
}
// Warning: (ae-internal-missing-underscore) The name "ScriptProps" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal (undocumented)

0 comments on commit 01b2907

Please sign in to comment.
You can’t perform that action at this time.