@hashicorp/react-docs-page NPM

DocsPage

The DocsPage component lets you create a Hashicorp branded docs page in NextJS projects using next-mdx-remote. This is a very highly abstracted component with slightly more involved usage since it renders an entire collection of pages.

Example Usage

This component is intended to be used on an optional catch-all route page, like pages/docs/[[...page]].mdx - example source shown below:

import DocsPage from '@hashicorp/react-docs-page'
// Imports below are only used server-side
import {
  generateStaticPaths,
  generateStaticProps,
} from '@hashicorp/react-docs-page/server'

//  Set up DocsPage settings
const BASE_ROUTE = 'docs'
const NAV_DATA = 'data/docs-nav-data.json'
const CONTENT_DIR = 'content/docs'
const PRODUCT = {
  name: 'Packer',
  slug: 'packer',
}

function DocsLayout(props) {
  return (
    <DocsPage baseRoute={BASE_ROUTE} product={PRODUCT} staticProps={props} />
  )
}

export async function getStaticPaths() {
  const paths = await generateStaticPaths({
    navDataFile: NAV_DATA,
    localContentDir: CONTENT_DIR,
  })
  return { paths, fallback: false }
}

export async function getStaticProps({ params }) {
  const props = await generateStaticProps({
    navDataFile: NAV_DATA,
    localContentDir: CONTENT_DIR,
    params,
    product: PRODUCT,
  })
  return { props }
}

export default DocsLayout

This may seem like a complex example, but there is a lot going on here. The component is taking care of an entire base-level route, including an index page and its potentially hundreds of sub-pages, while providing a minimal interface surface area.

In order for the search functionality to work properly, this component requires a .env file with the following keys filled in:

NEXT_PUBLIC_ALGOLIA_APP_ID
NEXT_PUBLIC_ALGOLIA_INDEX
NEXT_PUBLIC_ALGOLIA_SEARCH_ONLY_API_KEY

Props

See props.js for more information on props.

moize semver js-yaml readdirp classnames gray-matter line-reader fs-exists-sync @hashicorp/react-head @hashicorp/react-alert @hashicorp/react-search @hashicorp/react-content @hashicorp/platform-docs-mdx @hashicorp/react-placeholder @hashicorp/react-docs-sidenav @hashicorp/react-version-select @hashicorp/platform-markdown-utils

@everything-registry/sub-chunk-387 @zalastax/nolb-_has @hashicorp/react-glossary-page

17.9.1

2 years ago

17.9.1-canary-20231218234848

2 years ago

17.9.1-canary-20231122200025

2 years ago

17.9.1-canary-20231122200030

2 years ago

17.7.2-canary-20230324202437

3 years ago

17.9.0-canary-20230425213102

3 years ago

17.7.2

3 years ago

17.8.0

3 years ago

17.8.0-canary-20230411190718

3 years ago

17.9.0

3 years ago

17.8.0-canary-20220822170856

3 years ago

17.7.1

3 years ago

17.7.2-canary-20220902203013

3 years ago

17.8.0-canary-20220822165229

3 years ago

17.7.2-canary-20220902174756

3 years ago

17.7.1-canary-20220830165444

3 years ago

17.3.3-canary-20220802205844

3 years ago

17.3.0

3 years ago

17.3.2

3 years ago

17.3.1

3 years ago

17.3.2-canary-20220802201454

3 years ago

17.4.0-canary-20220803141418

3 years ago

17.3.3

3 years ago

17.4.0-canary-20220729170437

3 years ago

17.4.0

3 years ago

17.1.0-canary-20220630150904

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

17.4.0-canary-20220729163639

3 years ago

17.4.0-canary-20220803150030

3 years ago

17.3.1-canary-20220725180230

3 years ago

17.5.0

3 years ago

17.3.1-canary-20220725175558

3 years ago

17.1.2-canary-20220706153646

3 years ago

17.1.1-canary-20220705154019

3 years ago

17.6.0

3 years ago

17.0.0-canary-20220608120537

3 years ago

17.0.0-canary-20220608124347

3 years ago

17.0.0-canary-20220608134000

3 years ago

17.0.0-canary-20220608135211

3 years ago

16.1.0-canary-20220506142434

4 years ago

17.0.0-canary-20220607231611

3 years ago

16.2.0-canary-20220524215628

4 years ago

16.1.0-canary-20220506143415

4 years ago

16.2.0-canary-20220524215623

4 years ago

17.0.0-canary-20220607185849

3 years ago

16.1.0-canary-20220505214234

4 years ago

16.2.1-canary-20220607154456

3 years ago

17.0.0-canary-20220607185823

3 years ago

17.0.0-canary-20220608185248

3 years ago

17.0.0-canary-20220607192922

3 years ago

16.2.1-canary-20220607160359

3 years ago

17.0.0-canary-20220608191751

3 years ago

17.0.0-canary-20220608134652

3 years ago

16.1.0

4 years ago

16.2.1-canary-20220607163405

3 years ago

16.1.0-canary-20220506141537

4 years ago

16.2.1-canary-20220606001921

3 years ago

16.2.1-canary-20220606002209

3 years ago

16.2.1-canary-20220606001913

3 years ago

3 years ago

3 years ago

4 years ago

3 years ago

16.2.1-canary-20220607145024

3 years ago

17.0.0-canary-20220607221634

3 years ago

17.0.0-canary-20220608175619

3 years ago

17.0.0-canary-20220608155543

3 years ago

17.0.0-canary-20220607191431

3 years ago

15.0.0-canary-20220422165652

4 years ago

16.0.1-canary-20220427160739

4 years ago

14.16.0-canary-20220329201859

4 years ago

15.0.0

4 years ago

16.0.1-canary-20220427142747

4 years ago

15.0.0-canary-20220426200428

4 years ago

15.0.0-canary-20220426210227

4 years ago

15.0.0-canary-20220422160206

4 years ago

16.0.1-canary-20220427155517

4 years ago

14.14.6-canary-20220323190204

4 years ago

14.16.0-canary-20220328214913

4 years ago

14.16.1

4 years ago

14.14.6-canary-20220321163754

4 years ago

14.16.0

4 years ago

15.0.0-canary-20220426200725

4 years ago

14.14.6-canary-20220323213819

4 years ago

14.14.6-canary-20220323214107

4 years ago

14.15.0

4 years ago

14.16.1-canary-20220419231618

4 years ago

14.16.1-canary-20220415055307

4 years ago

16.0.1-canary-20220427141632

4 years ago

14.15.0-canary-20220324182850

4 years ago

14.16.0-canary-20220328212322

4 years ago

16.0.1-canary-20220427152744

4 years ago

16.0.0

4 years ago

14.14.5-canary-20220318185554

4 years ago

14.14.5-canary-20220318185541

4 years ago

14.14.5

4 years ago

14.14.4

4 years ago

14.15.0-canary-20220303004942

4 years ago

14.14.0-canary-202204192822

4 years ago

14.14.1-canary-20220131194346

4 years ago

14.14.1-canary-20220128215319

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

14.14.4-canary-20220224214219

4 years ago

14.14.1-canary-20220128211110

4 years ago

14.14.0-canary-2022011213255

4 years ago

14.14.1-canary-20220128211122

4 years ago

14.14.1-canary-20220128203034

4 years ago

14.14.0-canary-202204192210

4 years ago

14.14.1-canary-20220131233103

4 years ago

14.14.3-canary-20220223214927

4 years ago

14.14.2-canary-20220215211727

4 years ago

14.14.3-canary-20220223212614

4 years ago

14.13.1-canary-202205194550

4 years ago

14.12.0

4 years ago

14.9.0

4 years ago

14.9.0-canary-202111318446

4 years ago

14.11.0

4 years ago

14.10.0-canary-202111433436

4 years ago

14.10.0-canary-202111434549

4 years ago

14.8.1

4 years ago

14.13.0

4 years ago

14.8.0

4 years ago

15.0.0-canary-20211029153859

4 years ago

14.10.0-canary-202111445253

4 years ago

14.10.0-canary-20211145296

4 years ago

14.13.0-canary-20211117191239

4 years ago

14.10.0

4 years ago

14.13.0-canary-20211117173113

4 years ago

14.9.0-canary-2021113164434

4 years ago

15.0.0-canary-20211024211541

4 years ago

14.6.0-canary-2021109165810

4 years ago

14.6.1-canary-2021101521599

4 years ago

15.0.0-canary-20211023172716

4 years ago

14.8.0-canary-20211022211841

4 years ago

15.0.0-canary-2021102317016

4 years ago

14.7.0

4 years ago

14.7.0-canary-20211016172148

4 years ago

14.8.0-canary-20211022214546

4 years ago

14.6.0-canary-2021109195634

4 years ago

14.7.0-canary-2021101621136

4 years ago

14.8.0-canary-20211022232748

4 years ago

14.8.0-canary-20211022235456

4 years ago

14.7.0-canary-20211015233425

4 years ago

15.0.0-canary-20211023173848

4 years ago

14.6.1-canary-2021101618251

4 years ago

14.5.0

4 years ago

14.6.0-canary-2021109185917

4 years ago

14.6.1-canary-20211015214421

4 years ago

14.7.0-canary-20211016165533

4 years ago

14.6.0

4 years ago

14.6.1

4 years ago

14.7.0-canary-20211015221646

4 years ago

15.0.0-canary-20211024212548

4 years ago

14.7.0-canary-2021101815538

4 years ago

14.7.0-canary-202110162148

4 years ago

14.6.1-canary-2021101618722

4 years ago

15.0.0-canary-202110232298

4 years ago

14.6.1-canary-20211016151826

4 years ago

15.0.0-canary-20211024164256

4 years ago

14.5.0-canary-2021926201244

4 years ago

14.5.0-canary-2021922153914

4 years ago

14.4.5-canary-2021919162015

4 years ago

14.4.3-canary-2021914134739

4 years ago

14.5.0-canary-2021918154550

4 years ago

14.4.3-canary-2021913225516

4 years ago

14.4.5-canary-2021919155337

4 years ago

14.5.0-canary-2021913152717

4 years ago

14.5.0-canary-202191314343

4 years ago

14.4.5-canary-202191918515

4 years ago

14.4.5-canary-2021919161238

4 years ago

14.4.5-canary-202191915380

4 years ago

14.4.3-canary-202191320535

4 years ago

14.4.5-canary-2021919161251

4 years ago

14.4.5

4 years ago

14.4.3-canary-2021914144352

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

14.4.5-canary-2021919194510

4 years ago

14.4.0-canary-202194202150

4 years ago

14.4.1-canary-20219543523

4 years ago

14.4.0-canary-202194211831

4 years ago

14.3.0-canary-202194172037

4 years ago

14.3.0

4 years ago

14.3.1

4 years ago

14.4.1-canary-20219543144

4 years ago

14.4.1-canary-20219542942

4 years ago

14.4.0

4 years ago

14.3.0-canary-20219419120

4 years ago

14.3.0-canary-20219301052

4 years ago

14.3.0-canary-202192234459

4 years ago

14.2.6-canary-2021830165742

4 years ago

14.2.6-canary-2021830162224

4 years ago

14.2.4-canary-202183015355

4 years ago

14.3.0-canary-202191162454

4 years ago

14.3.0-canary-202191162448

4 years ago

14.2.6-canary-2021830163722

4 years ago

14.2.6-canary-202191152546

4 years ago

14.2.5

4 years ago

14.2.5-canary-202182821517

4 years ago

14.2.5-canary-202182916351

4 years ago

14.2.5-canary-2021829162549

4 years ago

14.2.5-canary-2021827162915

4 years ago

14.2.5-canary-202182716274

4 years ago

14.2.5-canary-20218272196

4 years ago

14.2.5-canary-202182818431

4 years ago

14.2.5-canary-2021828171520

4 years ago

14.2.5-canary-202182812456

4 years ago

14.2.5-canary-2021827155312

4 years ago

14.2.5-canary-202182803725

4 years ago

14.2.5-canary-20218281940

4 years ago

14.2.4-canary-2021822191839

4 years ago

14.2.4-canary-2021822191314

4 years ago

14.2.5-canary-202182365236

4 years ago

14.2.5-canary-202182382535

4 years ago

14.2.5-canary-20218235504

4 years ago

14.2.4

4 years ago

14.2.5-canary-202182364042

4 years ago

14.2.5-canary-202182301155

4 years ago

14.2.4-canary-2021822192419

4 years ago

14.2.5-canary-202182362825

4 years ago

14.2.5-canary-20218230432

4 years ago

14.2.5-canary-2021822235946

4 years ago

14.2.4-canary-202182219371

4 years ago

14.2.5-canary-202182303533

4 years ago

14.2.2-canary-2021821144039

4 years ago

14.2.1

4 years ago

14.2.2

4 years ago

14.2.3

4 years ago

14.2.2-canary-202182115136

4 years ago

14.2.1-canary-20218211480

4 years ago

14.2.3-canary-2021822153136

4 years ago

14.1.0

4 years ago

14.2.0-canary-202181520936

4 years ago

14.2.0-canary-202181521224

4 years ago

14.2.0

4 years ago

14.1.0-canary-202182175359

4 years ago

14.0.3

4 years ago

14.0.3-canary-202181152919

4 years ago

14.0.3-canary-20218116219

4 years ago

14.0.3-canary-202181151955

4 years ago

14.0.3-canary-202181142614

4 years ago

14.0.3-canary-202181155237

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago