@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 { getStaticGenerationFunctions } 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} />
  )
}

const { getStaticPaths, getStaticProps } = getStaticGenerationFunctions({
  strategy: 'fs',
  navDataFile: NAV_DATA,
  localContentDir: CONTENT_DIR,
  product: PRODUCT.slug,
})

export { getStaticPaths, getStaticProps }

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.

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

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

17.9.1

5 months ago

17.9.1-canary-20231218234848

5 months ago

17.9.1-canary-20231122200025

5 months ago

17.9.1-canary-20231122200030

5 months ago

17.7.2-canary-20230324202437

1 year ago

17.9.0-canary-20230425213102

1 year ago

17.7.2

1 year ago

17.8.0

1 year ago

17.8.0-canary-20230411190718

1 year ago

17.9.0

1 year ago

17.8.0-canary-20220822170856

2 years ago

17.7.1

2 years ago

17.7.2-canary-20220902203013

2 years ago

17.8.0-canary-20220822165229

2 years ago

17.7.2-canary-20220902174756

2 years ago

17.7.1-canary-20220830165444

2 years ago

17.3.3-canary-20220802205844

2 years ago

17.3.0

2 years ago

17.3.2

2 years ago

17.3.1

2 years ago

17.3.2-canary-20220802201454

2 years ago

17.4.0-canary-20220803141418

2 years ago

17.3.3

2 years ago

17.4.0-canary-20220729170437

2 years ago

17.4.0

2 years ago

17.1.0-canary-20220630150904

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

17.4.0-canary-20220729163639

2 years ago

17.4.0-canary-20220803150030

2 years ago

17.3.1-canary-20220725180230

2 years ago

17.5.0

2 years ago

17.3.1-canary-20220725175558

2 years ago

17.1.2-canary-20220706153646

2 years ago

17.1.1-canary-20220705154019

2 years ago

17.6.0

2 years ago

17.0.0-canary-20220608120537

2 years ago

17.0.0-canary-20220608124347

2 years ago

17.0.0-canary-20220608134000

2 years ago

17.0.0-canary-20220608135211

2 years ago

16.1.0-canary-20220506142434

2 years ago

17.0.0-canary-20220607231611

2 years ago

16.2.0-canary-20220524215628

2 years ago

16.1.0-canary-20220506143415

2 years ago

16.2.0-canary-20220524215623

2 years ago

17.0.0-canary-20220607185849

2 years ago

16.1.0-canary-20220505214234

2 years ago

16.2.1-canary-20220607154456

2 years ago

17.0.0-canary-20220607185823

2 years ago

17.0.0-canary-20220608185248

2 years ago

17.0.0-canary-20220607192922

2 years ago

16.2.1-canary-20220607160359

2 years ago

17.0.0-canary-20220608191751

2 years ago

17.0.0-canary-20220608134652

2 years ago

16.1.0

2 years ago

16.2.1-canary-20220607163405

2 years ago

16.1.0-canary-20220506141537

2 years ago

16.2.1-canary-20220606001921

2 years ago

16.2.1-canary-20220606002209

2 years ago

16.2.1-canary-20220606001913

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

16.2.1-canary-20220607145024

2 years ago

17.0.0-canary-20220607221634

2 years ago

17.0.0-canary-20220608175619

2 years ago

17.0.0-canary-20220608155543

2 years ago

17.0.0-canary-20220607191431

2 years ago

15.0.0-canary-20220422165652

2 years ago

16.0.1-canary-20220427160739

2 years ago

14.16.0-canary-20220329201859

2 years ago

15.0.0

2 years ago

16.0.1-canary-20220427142747

2 years ago

15.0.0-canary-20220426200428

2 years ago

15.0.0-canary-20220426210227

2 years ago

15.0.0-canary-20220422160206

2 years ago

16.0.1-canary-20220427155517

2 years ago

14.14.6-canary-20220323190204

2 years ago

14.16.0-canary-20220328214913

2 years ago

14.16.1

2 years ago

14.14.6-canary-20220321163754

2 years ago

14.16.0

2 years ago

15.0.0-canary-20220426200725

2 years ago

14.14.6-canary-20220323213819

2 years ago

14.14.6-canary-20220323214107

2 years ago

14.15.0

2 years ago

14.16.1-canary-20220419231618

2 years ago

14.16.1-canary-20220415055307

2 years ago

16.0.1-canary-20220427141632

2 years ago

14.15.0-canary-20220324182850

2 years ago

14.16.0-canary-20220328212322

2 years ago

16.0.1-canary-20220427152744

2 years ago

16.0.0

2 years ago

14.14.5-canary-20220318185554

2 years ago

14.14.5-canary-20220318185541

2 years ago

14.14.5

2 years ago

14.14.4

2 years ago

14.15.0-canary-20220303004942

2 years ago

14.14.0-canary-202204192822

2 years ago

14.14.1-canary-20220131194346

2 years ago

14.14.1-canary-20220128215319

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

14.14.4-canary-20220224214219

2 years ago

14.14.1-canary-20220128211110

2 years ago

14.14.0-canary-2022011213255

2 years ago

14.14.1-canary-20220128211122

2 years ago

14.14.1-canary-20220128203034

2 years ago

14.14.0-canary-202204192210

2 years ago

14.14.1-canary-20220131233103

2 years ago

14.14.3-canary-20220223214927

2 years ago

14.14.2-canary-20220215211727

2 years ago

14.14.3-canary-20220223212614

2 years ago

14.13.1-canary-202205194550

2 years ago

14.12.0

2 years ago

14.9.0

2 years ago

14.9.0-canary-202111318446

2 years ago

14.11.0

2 years ago

14.10.0-canary-202111433436

2 years ago

14.10.0-canary-202111434549

2 years ago

14.8.1

2 years ago

14.13.0

2 years ago

14.8.0

2 years ago

15.0.0-canary-20211029153859

2 years ago

14.10.0-canary-202111445253

2 years ago

14.10.0-canary-20211145296

2 years ago

14.13.0-canary-20211117191239

2 years ago

14.10.0

2 years ago

14.13.0-canary-20211117173113

2 years ago

14.9.0-canary-2021113164434

2 years ago

15.0.0-canary-20211024211541

2 years ago

14.6.0-canary-2021109165810

2 years ago

14.6.1-canary-2021101521599

2 years ago

15.0.0-canary-20211023172716

2 years ago

14.8.0-canary-20211022211841

2 years ago

15.0.0-canary-2021102317016

2 years ago

14.7.0

2 years ago

14.7.0-canary-20211016172148

2 years ago

14.8.0-canary-20211022214546

2 years ago

14.6.0-canary-2021109195634

2 years ago

14.7.0-canary-2021101621136

2 years ago

14.8.0-canary-20211022232748

2 years ago

14.8.0-canary-20211022235456

2 years ago

14.7.0-canary-20211015233425

2 years ago

15.0.0-canary-20211023173848

2 years ago

14.6.1-canary-2021101618251

2 years ago

14.5.0

3 years ago

14.6.0-canary-2021109185917

2 years ago

14.6.1-canary-20211015214421

2 years ago

14.7.0-canary-20211016165533

2 years ago

14.6.0

2 years ago

14.6.1

2 years ago

14.7.0-canary-20211015221646

2 years ago

15.0.0-canary-20211024212548

2 years ago

14.7.0-canary-2021101815538

2 years ago

14.7.0-canary-202110162148

2 years ago

14.6.1-canary-2021101618722

2 years ago

15.0.0-canary-202110232298

2 years ago

14.6.1-canary-20211016151826

2 years ago

15.0.0-canary-20211024164256

2 years ago

14.5.0-canary-2021926201244

3 years ago

14.5.0-canary-2021922153914

3 years ago

14.4.5-canary-2021919162015

3 years ago

14.4.3-canary-2021914134739

3 years ago

14.5.0-canary-2021918154550

3 years ago

14.4.3-canary-2021913225516

3 years ago

14.4.5-canary-2021919155337

3 years ago

14.5.0-canary-2021913152717

3 years ago

14.5.0-canary-202191314343

3 years ago

14.4.5-canary-202191918515

3 years ago

14.4.5-canary-2021919161238

3 years ago

14.4.5-canary-202191915380

3 years ago

14.4.3-canary-202191320535

3 years ago

14.4.5-canary-2021919161251

3 years ago

14.4.5

3 years ago

14.4.3-canary-2021914144352

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

14.4.5-canary-2021919194510

3 years ago

14.4.0-canary-202194202150

3 years ago

14.4.1-canary-20219543523

3 years ago

14.4.0-canary-202194211831

3 years ago

14.3.0-canary-202194172037

3 years ago

14.3.0

3 years ago

14.3.1

3 years ago

14.4.1-canary-20219543144

3 years ago

14.4.1-canary-20219542942

3 years ago

14.4.0

3 years ago

14.3.0-canary-20219419120

3 years ago

14.3.0-canary-20219301052

3 years ago

14.3.0-canary-202192234459

3 years ago

14.2.6-canary-2021830165742

3 years ago

14.2.6-canary-2021830162224

3 years ago

14.2.4-canary-202183015355

3 years ago

14.3.0-canary-202191162454

3 years ago

14.3.0-canary-202191162448

3 years ago

14.2.6-canary-2021830163722

3 years ago

14.2.6-canary-202191152546

3 years ago

14.2.5

3 years ago

14.2.5-canary-202182821517

3 years ago

14.2.5-canary-202182916351

3 years ago

14.2.5-canary-2021829162549

3 years ago

14.2.5-canary-2021827162915

3 years ago

14.2.5-canary-202182716274

3 years ago

14.2.5-canary-20218272196

3 years ago

14.2.5-canary-202182818431

3 years ago

14.2.5-canary-2021828171520

3 years ago

14.2.5-canary-202182812456

3 years ago

14.2.5-canary-2021827155312

3 years ago

14.2.5-canary-202182803725

3 years ago

14.2.5-canary-20218281940

3 years ago

14.2.4-canary-2021822191839

3 years ago

14.2.4-canary-2021822191314

3 years ago

14.2.5-canary-202182365236

3 years ago

14.2.5-canary-202182382535

3 years ago

14.2.5-canary-20218235504

3 years ago

14.2.4

3 years ago

14.2.5-canary-202182364042

3 years ago

14.2.5-canary-202182301155

3 years ago

14.2.4-canary-2021822192419

3 years ago

14.2.5-canary-202182362825

3 years ago

14.2.5-canary-20218230432

3 years ago

14.2.5-canary-2021822235946

3 years ago

14.2.4-canary-202182219371

3 years ago

14.2.5-canary-202182303533

3 years ago

14.2.2-canary-2021821144039

3 years ago

14.2.1

3 years ago

14.2.2

3 years ago

14.2.3

3 years ago

14.2.2-canary-202182115136

3 years ago

14.2.1-canary-20218211480

3 years ago

14.2.3-canary-2021822153136

3 years ago

14.1.0

3 years ago

14.2.0-canary-202181520936

3 years ago

14.2.0-canary-202181521224

3 years ago

14.2.0

3 years ago

14.1.0-canary-202182175359

3 years ago

14.0.3

3 years ago

14.0.3-canary-202181152919

3 years ago

14.0.3-canary-20218116219

3 years ago

14.0.3-canary-202181151955

3 years ago

14.0.3-canary-202181142614

3 years ago

14.0.3-canary-202181155237

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 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

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