<GlossaryPage> ComponentThis is a specialized view built on top of DocsPage to render a glossary page on our docs sites.
<GlossaryPage product={{ name: 'Consul', slug: 'consul' }} staticProps={staticPropsResult} />
| Name | Description |
|---|---|
productobject | Name and slug of the product this page is being rendered for Object contains nested props, see below: |
product.namestring | Human-readable proper case product name |
product.slugstring | HashiCorp product slug |
additionalComponentsobject | Object containing additional components to be made available within mdx pages. Uses the format { [key]: Component }, for example, { TestComponent: () => <p>hello world</p> } |
showEditPageboolean | if true, an "edit this page" link will appear on the bottom right |
staticPropsobject | Directly pass the return value of server/generateStaticProps in here.Object contains nested props, see below: |
staticProps.termsarray | A list of glossary terms, passed to <GlossaryTableOfContents />Array members must be of the type below: |
staticProps.terms[x]object | A glossary term item Object contains nested props, see below: |
staticProps.terms[x].slugstring | The term's slug, used to construct an anchor link |
staticProps.terms[x].titlestring | The term's title, used to label an anchor link to the term |
staticProps.githubFileUrlstring | A link to the page's associated .mdx file on GitHub. Used for the Edit this page link. |
staticProps.mdxSource*object | Data returned from running next-mdx-remote/serialize on the page's .mdx file contents. |
staticProps.navData*object | Tree of navigation data to render. See docs-sidenav/types.js for details. |