1.5.1 • Published 2 years ago

@hashicorp/react-markdown-page v1.5.1

Weekly downloads
124
License
MPL-2.0
Repository
-
Last release
2 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,
  })
}
@hashicorp/platform-markdown-utils@hashicorp/react-content@hashicorp/react-headgray-matternext-mdx-remote
@everything-registry/sub-chunk-387@zalastax/nolb-_has
1.5.1-canary-20220128203034

2 years ago

1.5.1-canary-20220128211122

2 years ago

1.5.1-canary-20220128211110

2 years ago

1.5.1-canary-20220128215319

2 years ago

1.5.1-canary-20220131233103

2 years ago

1.5.1

2 years ago

1.5.1-canary-20220131194346

2 years ago

1.5.0

2 years ago

2.0.0-canary-20211029153859

2 years ago

2.0.0-canary-20211024212548

2 years ago

2.0.0-canary-20211024211541

2 years ago

1.4.4-canary-2021913225516

3 years ago

1.4.4

3 years ago

1.4.4-canary-2021914144352

3 years ago

1.4.4-canary-202191320535

3 years ago

1.4.4-canary-2021914134739

3 years ago

1.4.3

3 years ago

1.4.2

3 years ago

1.4.1

3 years ago

1.4.1-alpha.34

3 years ago

1.3.2-alpha.31

3 years ago

1.4.0

3 years ago

1.3.2-alpha.32

3 years ago

1.3.2-alpha.28

3 years ago

1.3.1-alpha.24

3 years ago

1.3.1

3 years ago

1.3.1-alpha.13

3 years ago

1.3.1-alpha.14

3 years ago

1.3.1-alpha.10

3 years ago

1.3.1-alpha.9

3 years ago

1.3.1-alpha.19

3 years ago

1.3.1-alpha.17

3 years ago

1.3.1-alpha.18

3 years ago

1.3.1-alpha.7

3 years ago

1.3.1-alpha.16

3 years ago

1.3.1-alpha.6

3 years ago

1.2.1-alpha.39

3 years ago

1.3.0

3 years ago

1.2.0

3 years ago

1.1.3-alpha.15

3 years ago

1.1.2

3 years ago

1.1.1

3 years ago

1.0.0

3 years ago

1.1.0

3 years ago

0.2.4-next.34

3 years ago

0.2.4-pr170.28

3 years ago

0.2.3

3 years ago

0.2.2

3 years ago

0.2.1

3 years ago

0.2.0

3 years ago

0.1.0

3 years ago