NeatoJSTheme components
<GuiderLayout />#
React component that will show the currently configured layout partial.
It respects the configured layout in the layout settings. Read more about partials.
The primary use of this component is to make a non-MDX page look like an MDX page. Don't use it if you're already in an MDX File.
Will show one of:
- The default layout with the configured settings.
- The custom component if the layout has been overriden in the partials.
Example#
<GuiderLayout meta={{ layout: 'page' }}>
<h1>Custom page</h1>
<p>This is a custom page that doesn't use MDX</p>
</GuiderLayout>Reference#
function GuiderLayout(props);propsobjectrequired
The props for this component. Every prop is optional.
metaMetaConf
The meta configuration, see the meta file reference for the contents.
excerptstring
An excerpt of the page, used in meta tags for SEO.
headingsMdxHeadings[]
The headings of the page, first depth 1 heading is used as page title for SEO.
This is also to display the table of contents.
childrenReactNode
The children of the React component, it will be displayed as the page contents.