Skip to content

Latest commit

 

History

History
497 lines (277 loc) · 25.1 KB

CHANGELOG.md

File metadata and controls

497 lines (277 loc) · 25.1 KB

@hashicorp/react-docs-page

17.9.1

Patch Changes

17.9.0

Minor Changes

17.8.0

Minor Changes

17.7.2

Patch Changes

17.7.1

Patch Changes

17.7.0

Minor Changes

17.6.0

Minor Changes

17.5.0

Minor Changes

17.4.0

Minor Changes

17.3.3

Patch Changes

  • #676 22d16677 Thanks @BRKalow! - Fix condition for applying the margin top to align search with the version select

17.3.2

Patch Changes

17.3.1

Patch Changes

17.3.0

Minor Changes

17.2.0

Minor Changes

  • #650 c9719e1b Thanks @BRKalow! - Adds new projectName prop, which is used to augment the version select label.

17.1.2

Patch Changes

  • #639 c8c945f4 Thanks @thiskevinwang! - This fixes incorrect logic for parsing and stripping a TFE version from Next.js path params.

17.1.1

Patch Changes

17.1.0

Minor Changes

17.0.1

Patch Changes

  • Updated dependencies [c3a29de1]:
    • @hashicorp/react-version-select@0.4.0

17.0.0

Major Changes

  • #607 c4308f52 Thanks @zchsh! - BREAKING CHANGE: no longer provides default remark and rehype plugins.

    Consumers should pass all remarkPlugins and rehypePlugins through loader options. To match previous behaviour, consumers should import our @hashicorp/remark-plugins as well as code highlighting plugins.

    // Shared remark plugins
    import {
      includeMarkdown,
      paragraphCustomAlerts,
      typography,
      anchorLinks,
    } from '@hashicorp/remark-plugins'
    // Code highlighting
    import rehypePrism from '@mapbox/rehype-prism'
    import rehypeSurfaceCodeNewlines from '@hashicorp/platform-code-highlighting/rehype-surface-code-newlines'
    // To enable math features, add remarkMath & rehypeKatex
    // import remarkMath from 'remark-math'
    // import rehypeKatex from 'rehype-katex'
    
    const remarkPlugins = [
      [
        includeMarkdown,
        {
          resolveMdx: true,
          resolveFrom: path.join(process.cwd(), localPartialsDir),
        },
      ],
      paragraphCustomAlerts,
      typography,
      anchorLinks,
      /* ... option to add more plugins here ... */
    ]
    
    const rehypePlugins = [
      [rehypePrism, { ignoreMissing: true }],
      rehypeSurfaceCodeNewlines,
      /* ... option to add more plugins here ... */
    ]

16.2.1

Patch Changes

  • #603 ad19f3d5 Thanks @zchsh! - Fixes issue where URLs with trailing index would resolve, rather than 404 as expected.

16.2.0

Minor Changes

  • #597 b2c02280 Thanks @BRKalow! - Adds optInBanner prop to render an optInBanner in the content area

16.1.0

Minor Changes

  • #583 27a251e2 Thanks @thiskevinwang! - This version adds a navDataPrefix option to the RemoteContentLoader to make nav-data lookup more flexible.

16.0.0

Major Changes

Patch Changes

  • Updated dependencies [36f924ae]:
    • @hashicorp/react-docs-sidenav@9.0.0

15.0.0

Major Changes

14.16.1

Patch Changes

  • #569 21e78bfe Thanks @zchsh! - Bumps @hashicorp/react-content dependency to fix a table alignment issues. See #562 for details.

14.16.0

Minor Changes

14.15.0

Minor Changes

  • #524 657f44b3 Thanks @BRKalow! - Support passing a function for remarkPlugins, which accepts the params for the current page being rendered.

14.14.5

Patch Changes

  • #541 d68f7db0 Thanks @dstaley! - Update TypeScript types to allow null as a value for canonicalUrl

14.14.4

Patch Changes

  • #516 ceb89b24 Thanks @dstaley! - Ignore non-jump-to-section tagged H2 elements within the content of a DocsPage

14.14.3

Patch Changes

  • #504 25d353c Thanks @zchsh! - Bumps platform-docs-mdx to fix a manual copy issue in code-block

14.14.2

Patch Changes

  • #508 f0bfe27 Thanks @BRKalow! - Adds CodeTabsProvider to DocsPage, which is necessary for syncing language selection across multiple CodeTabs instances.

14.14.1

Patch Changes

  • #498 e60fa8f Thanks @BRKalow! - Bumps underlying dependencies.

  • Updated dependencies [e60fa8f]:

    • @hashicorp/react-content@8.2.1
    • @hashicorp/react-search@6.4.1

14.14.0

Minor Changes

  • #484 5d9f538 Thanks @thiskevinwang! - DocsPage

    • Rename DocsPageWrapper to DocsPageInner
    • Hide VersionAlert if version in path is "latest"

    GlossaryPage

    • Update internal import

Patch Changes

  • Updated dependencies [a6a6ba4]:
    • @hashicorp/react-content@8.1.1

14.13.0

Minor Changes

Patch Changes

  • Updated dependencies [22a02a4]:
    • @hashicorp/react-version-select@0.3.0

14.12.0

Minor Changes

14.11.0

Minor Changes

  • #461 4270c8a Thanks @dstaley! - Update to latest version of @hashicorp/platform-markdown-utils

Patch Changes

  • Updated dependencies [03d83a6, e545db4]:
    • @hashicorp/react-search@6.3.1
    • @hashicorp/react-content@8.1.0

14.10.0

Minor Changes

  • #453 eabad4b Thanks @zchsh! - Exposes new, optional localPartialsDir option for the filesystem loader.

14.9.0

Minor Changes

Patch Changes

  • Updated dependencies [68ab860]:
    • @hashicorp/react-search@6.3.0

14.8.1

Patch Changes

14.8.0

Minor Changes

14.7.0

Minor Changes

  • #424 02428a8 Thanks @zchsh! - Add support for Algolia config, through an optional algoliaConfig prop, which is passed to react-search. This prop can be omitted, or provided with incomplete properties, and react-search will fall back to environment variables.

Patch Changes

  • Updated dependencies [02428a8]:
    • @hashicorp/react-search@6.2.0

14.6.1

Patch Changes

14.6.0

Minor Changes

14.5.0

Minor Changes

  • #390 57e5b21 Thanks @BRKalow! - Refactor docs page server-side code to use a new loaders pattern. Updates the existing generateStatic* functions to use the FileLoader under the hood, while marking them as deprecated.

Patch Changes

14.4.5

Patch Changes

  • #402 2f9b9c6 Thanks @zchsh! - Patches issue where DocsPageWrapper was not exported. Without this export, GlossaryPage can cause Vercel builds of react-components to fail.

14.4.4

Patch Changes

14.4.3

Patch Changes

  • #393 950f79c Thanks @kendallstrautman! - Upgrades the @hashicorp/markdown-utils dep to pull in a remark plugin a11y change

  • Updated dependencies [8012b33]:

    • @hashicorp/react-alert@6.0.2

14.4.2

Patch Changes

  • #388 a906a8d Thanks @BRKalow! - Adds styles for search hits and adds units to a variable so that it works in calc()

  • Updated dependencies [a906a8d]:

    • @hashicorp/react-search@6.1.1

14.4.1

Patch Changes

  • #358 ef6333f Thanks @zchsh! - Support possibility of index page being included in nav-data.
  • #382 cc46ed6 Thanks @thiskevinwang! - This updates logic to check process.env.ENABLE_VERSIONED_DOCS === 'true' since environment variables are always strings.

    This should prevent some unintended behavior if ENABLE_VERSIONED_DOCS is parsed as a string "false", but unintentionally evaluating to truthy

  • Updated dependencies [ef6333f]:

    • @hashicorp/react-docs-sidenav@8.4.0

14.4.0

Minor Changes

  • #373 4a5204b Thanks @thiskevinwang! - construct githubFileUrl to be used w/ Edit this page

    • This links to the main branch file while on the latest version
    • This is hidden for non-latest versions

Patch Changes

  • Updated dependencies [fe1fe69]:
    • @hashicorp/react-search@6.0.2

14.3.1

Patch Changes

14.3.0

Minor Changes

  • #354 929b9b4 Thanks @thiskevinwang! - react-docs-page now makes api-calls to the mktg-content-workflows' content api

    #360 refactored server code to TypeScript

Patch Changes

  • Updated dependencies [9b190b0]:
    • @hashicorp/react-docs-sidenav@8.3.0

14.2.5

Patch Changes

  • #362 77e5712 Thanks @BRKalow! - Adjust prop interface to make showVersionSelect, additionalComponents, and showEditPage optional

14.2.4

Patch Changes

  • #353 8a83473 Thanks @zchsh! - Patches an issue in @hashicorp/platform-docs-mdx related to Tabs styling.

14.2.3

Patch Changes

  • #351 a3358e6 Thanks @BRKalow! - - Updates @hashicorp/platform-docs-mdx package to one that relies on the latest versions of our components

14.2.2

Patch Changes

  • #348 4ac0276 Thanks @BRKalow! - Adds back @hashicorp/versioned-docs dependency to docs-page as it is still used

14.2.1

Patch Changes

  • #346 14f7b1f Thanks @BRKalow! - Update docs-page to depend on @hashicorp/react-version-select instead of @hashicorp/version-select

14.2.0

Minor Changes

  • #342 348434e Thanks @thiskevinwang! - feat(version-select): added removeVersionFromPath util feat(react-docs-page): use new VersionSelect; add test coverage; expose extra prop

Patch Changes

  • Updated dependencies [348434e]:
    • @hashicorp/version-select@0.2.0

14.1.0

Minor Changes

14.0.3

Patch Changes

  • #298 4c3e3d1 Thanks @zchsh! - Converts Search to CSS modules, and makes tweaks in consuming components to account for related changes.

    • 💥✨ BREAKING CHANGE: Refactored to CSS modules.
      • Consumers will need to remove any @hashicorp/react-search/style.css imports.
      • For .hit-content, consumers will need to import @hashicorp/react-search/hit-content-styles.module.css, and use s.root on their renderHitContent container.
  • Updated dependencies [4c3e3d1]:

    • @hashicorp/react-docs-sidenav@8.2.5
    • @hashicorp/react-search@6.0.0