1.5.1 • Published 3 years ago

@hashicorp/react-markdown-page v1.5.1

Weekly downloads
124
License
MPL-2.0
Repository
-
Last release
3 years ago

<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,
  })
}
gray-matternext-mdx-remote@hashicorp/react-head@hashicorp/react-content@hashicorp/platform-markdown-utils
@everything-registry/sub-chunk-387@zalastax/nolb-_has
1.5.1-canary-20220128203034

3 years ago

1.5.1-canary-20220128211122

3 years ago

1.5.1-canary-20220128211110

3 years ago

1.5.1-canary-20220128215319

3 years ago

1.5.1-canary-20220131233103

3 years ago

1.5.1

3 years ago

1.5.1-canary-20220131194346

3 years ago

1.5.0

4 years ago

2.0.0-canary-20211029153859

4 years ago

2.0.0-canary-20211024212548

4 years ago

2.0.0-canary-20211024211541

4 years ago

1.4.4-canary-2021913225516

4 years ago

1.4.4

4 years ago

1.4.4-canary-2021914144352

4 years ago

1.4.4-canary-202191320535

4 years ago

1.4.4-canary-2021914134739

4 years ago

1.4.3

4 years ago

1.4.2

4 years ago

1.4.1

4 years ago

1.4.1-alpha.34

4 years ago

1.3.2-alpha.31

4 years ago

1.4.0

4 years ago

1.3.2-alpha.32

4 years ago

1.3.2-alpha.28

4 years ago

1.3.1-alpha.24

4 years ago

1.3.1

4 years ago

1.3.1-alpha.13

4 years ago

1.3.1-alpha.14

4 years ago

1.3.1-alpha.10

4 years ago

1.3.1-alpha.9

4 years ago

1.3.1-alpha.19

4 years ago

1.3.1-alpha.17

4 years ago

1.3.1-alpha.18

4 years ago

1.3.1-alpha.7

4 years ago

1.3.1-alpha.16

4 years ago

1.3.1-alpha.6

4 years ago

1.2.1-alpha.39

4 years ago

1.3.0

4 years ago

1.2.0

4 years ago

1.1.3-alpha.15

4 years ago

1.1.2

4 years ago

1.1.1

4 years ago

1.0.0

4 years ago

1.1.0

4 years ago

0.2.4-next.34

4 years ago

0.2.4-pr170.28

4 years ago

0.2.3

4 years ago

0.2.2

4 years ago

0.2.1

4 years ago

0.2.0

4 years ago

0.1.0

5 years ago