@hashicorp/react-markdown-page
v1.5.1
Published
Create a single page based on a mdx file in NextJS projects.
Downloads
127
Maintainers
gstewart-hashi
prestonbourne
mikegolus
leahmariebush
kaitlynnefuery
abhishek-hashicorp
cameronperera
alexju
consul-ui-services
hashicb
britt.lindgren
paulhcp
nandereck
tstormk
hashibot-hds
lackeyjb1
jpogran
thrashr888
melsumner
didoo
zchsh
hcitsec
gregone
meirish
enmod
kaxcode
anubhavmishra-hashicorp
hashibot-web
cstitt-hashi
mocohen
dhaulagiriKeywords
Readme
<MarkdownPage />
This component renders a single page built from a separate markdown file.
Usage
import MarkdownPage from '@hashicorp/react-markdown-page'
import generateStaticProps from '@hashicorp/react-markdown-page/server'
export default function MyPage({ staticProps }) {
return <MarkdownPage {...staticProps} />
}
export function getStaticProps() {
return generateStaticProps({
pagePath: 'content/test-page.mdx', // resolved from project root
})
}If the specified page contains front matter, the page_title and description keys will be added as the title and description the the <head> of the page.
If you would like to use markdown components within the page, you can pass a components argument to both generateStaticProps and <MarkdownPage />, as such:
import MarkdownPage from '@hashicorp/react-markdown-page'
import generateStaticProps from '@hashicorp/react-markdown-page/server'
import TestComponent from './test-component'
const components = { TestComponent }
export default function MyPage({ staticProps }) {
return <MarkdownPage {...staticProps} components={components} />
}
export function getStaticProps() {
return generateStaticProps({
pagePath: 'content/test-page.mdx', // resolved from project root
components,
})
}