@commercetools-docs/[email protected]

Patch Changes

• Updated dependencies [c18f1fa, c18f1fa]:
  • @commercetools-docs/[email protected]

@commercetools-docs/[email protected]

Patch Changes

• 18976f7 #427 Thanks @emmenko! - Add a new template for the website homepage index.mdx. The page header renders a hero background image that can be defined by choosing one of the predefined color presets, using the colorPreset theme option.

  A color preset is what identifies a website or a group or content-related websites.

  At the moment the available presets are:

  • base (default)
  • merchantCenterDeveloperDocs
  • merchantCenterUserDocs
  • platformDeveloperDocs

  Breaking changes

  The theme option websitePrimaryColor has been removed in favor of the new option colorPreset.

@commercetools-docs/[email protected]

Major Changes

• 18976f7 #427 Thanks @emmenko! - Add a new template for the website homepage index.mdx. The page header renders a hero background image that can be defined by choosing one of the predefined color presets, using the colorPreset theme option.

  A color preset is what identifies a website or a group or content-related websites.

  At the moment the available presets are:

  • base (default)
  • merchantCenterDeveloperDocs
  • merchantCenterUserDocs
  • platformDeveloperDocs

  Breaking changes

  The theme option websitePrimaryColor has been removed in favor of the new option colorPreset.

Minor Changes

• f8d349b #420 Thanks @davifantasia! - Implement release notes dates and topics filters

Patch Changes

• Updated dependencies [18976f7]:
  • @commercetools-docs/[email protected]

@commercetools-docs/[email protected]

Patch Changes

• Updated dependencies [18976f7, f8d349b]:
  • @commercetools-docs/[email protected]
  • @commercetools-docs/[email protected]

@commercetools-docs/[email protected]

Patch Changes

• Updated dependencies [18976f7, f8d349b]:
  • @commercetools-docs/[email protected]
  • @commercetools-docs/[email protected]

@commercetools-docs/[email protected]

Patch Changes

• Updated dependencies [18976f7, f8d349b]:
  • @commercetools-docs/[email protected]
  • @commercetools-docs/[email protected]

v3.0.0

3.0.0 (2020-05-08)

This release introduces some breaking changes, as documented below.

• Dropping node v10 support
• The @commercetools-docs/broken-link-checker package has been removed. The NPM package is still available but it's marked as deprecated. As a replacement, we recommend using the linkinator package.
• The @commercetools-docs/gatsby-theme-api-docs is now a theme "add-on" (read more about "add-ons" below).
• The @commercetools-docs/gatsby-transformer-code-examples is now a theme "add-on" (read more about "add-ons" below) and has been renamed to @commercetools-docs/gatsby-theme-code-examples.

Introducing Gatsby Theme Add-Ons

A theme add-on is a Gatsby Theme that exposes React components to be injected into the MDX provider of the core theme.

Gatsby enables a child theme to use component shadowing (see Theme overrides). However, with multiple themes, the shadowed components are only loaded from the last theme in the Gatsby configuration. To solve this problem, a commercetools-docs Gatsby Theme can be used as an add-on, allowing multiple add-ons to provide additional components to be available in MDX without having to manually import them into every page.

When using add-on themes, a proxy export file will be generated in the websites src/@commercetools-docs/gatsby-theme-docs/overrides folder to leverage Gatsby's component shadowing (see Theme overrides). This file provides all the exported components from the add-on packages. For a component to be exported by an add-on package it has to be exported from index.js in the add-on package root.

To safely configure theme add-ons, use the configureThemeWithAddOns function in the websites's gatsby-config.js:

const {
  configureThemeWithAddOns,
} = require('@commercetools-docs/gatsby-theme-docs/configure-theme');

module.exports = {
  plugins: [
    ...configureThemeWithAddOns({
      // Pass the normal theme options
      websiteKey: 'my-website-key',
      // Set up the theme add-ons
      addOns: [
        '@commercetools-docs/gatsby-theme-foo',
        {
          resolve: '@commercetools-docs/gatsby-theme-bar',
          options: {
            // ...
          },
        },
      ],
    }),
  ],
};

🐛 Type: Bug

• gatsby-theme-docs
  • #413 fix: element keys should be unique (@davifantasia)
  • #407 fix(theme): render proper 404 page as a content page (@emmenko)
  • #399 fix: inconsistent url and title or index nav (@davifantasia)
  • #394 fix(theme): gracefully handle missing heading level in TOC (@emmenko)
  • #388 fix(theme-docs): Render mdx commonmark compliant (@nkuehn)
  • #384 fix(theme): sticky page nav and scrolling container (@emmenko)
  • #380 fix(theme): rss link to be treated as external link (@emmenko)
• gatsby-transformer-raml
  • #386 fix: stop rendering deprecated properties (@davifantasia)
• gatsby-theme-docs, ui-kit
  • #382 fix(theme): proptype warnings and mapping of some md elements (@emmenko)

💥 Type: Breaking Change

• broken-link-checker
  • #424 feat: use linkinator, drop broken-link-checker (@emmenko)
• gatsby-theme-docs
  • #423 refactor: require node 12 (@emmenko)
• gatsby-theme-api-docs, gatsby-theme-code-examples, gatsby-theme-docs
  • #422 feat: implement add-ons mechanism to merge markdown components from different add-on themes (@emmenko)
• gatsby-theme-api-docs
  • #412 refactor(api-theme): compose themes in website instead of inheriting (@nkuehn)

🔮 Type: Chore

• #383 refactor(ci): to not use cypress github action (@emmenko)

💅 Type: Enhancement

• writing-style
  • #410 WIP writing style: adjustments (@adinakleine)
• Other
  • #398 enhancement(workspace): set the window title better find the window (@nkuehn)

🚀 Type: New Feature

• gatsby-theme-code-examples, gatsby-theme-constants, gatsby-theme-docs
  • #402 feat: add gatsby theme to work with constant values (@davifantasia)
• gatsby-theme-api-docs, gatsby-theme-code-examples, gatsby-theme-docs
  • #422 feat: implement add-ons mechanism to merge markdown components from different add-on themes (@emmenko)
• gatsby-theme-docs, ui-kit
  • #411 feat(theme): allow to configure website primary color (@emmenko)
  • #371 feat: release notes details page (@davifantasia)
  • #376 feat(docs-theme): make beta flag available in any content (@nkuehn)
• gatsby-theme-docs
  • #400 feat(theme): allow to override top-menu links (@emmenko)
  • #390 Support custom anchors in MD(X) using (@davifantasia)
• gatsby-theme-api-docs, gatsby-theme-docs
  • #375 Release Notes: Render excerpt in list with reduced formatting, show read more. (@nkuehn)

⛑ Type: Refactoring

• gatsby-theme-code-examples, gatsby-theme-docs, gatsby-transformer-code-examples
  • #419 refactor(code-examples): make it a gatsby theme (@emmenko)
• gatsby-theme-api-docs
  • #412 refactor(api-theme): compose themes in website instead of inheriting (@nkuehn)
• gatsby-theme-api-docs, gatsby-theme-docs
  • #375 Release Notes: Render excerpt in list with reduced formatting, show read more. (@nkuehn)

🤖 Type: Dependencies

• gatsby-theme-api-docs, gatsby-theme-docs, gatsby-transformer-mdx-introspection, ramldoc-generator, writing-style
  • #418 chore(deps): lock file maintenance all dependencies (@renovate[bot])
• Other
  • #417 chore(deps): update dependency eslint-plugin-react-hooks to v4 (@renovate[bot])
• gatsby-theme-docs, ui-kit
  • #378 fix(deps): update all dependencies (major) (@renovate[bot])
• broken-link-checker, gatsby-theme-api-docs, gatsby-theme-docs, gatsby-transformer-mdx-introspection, ramldoc-generator
  • #379 chore(deps): lock file maintenance all dependencies (@renovate[bot])

v2.5.0

2.5.0 (2020-04-17)

🐛 Type: Bug

• gatsby-theme-docs, gatsby-transformer-code-examples
  • #370 fix(theme): to not restrict content page nodes for specific filesystem (@emmenko)
• writing-style
  • #366 Writing Style Linter: Update vale and prevent binary from being published (@nkuehn)
• gatsby-theme-docs
  • #347 fix(theme): to use height auto for small screens (@emmenko)
  • #351 fix(theme): remove check for zeit github branch (@emmenko)
  • #348 fix(theme): dynamically render the cookie consent scripts only on *.commercetools.com domain (@nkuehn)
  • #350 fix: leftovers of release notes layout implementation (@emmenko)

🔮 Type: Chore

• #353 chore(ci): add workflow to verify PR labels are assigned (@emmenko)

💅 Type: Enhancement

• gatsby-theme-docs
  • #331 Nav Content: Add Integrations marketplace to meta nav (@nkuehn)
• writing-style
  • #356 Writing Style: match the date formatting style hint to our actual styleguide rule (@nkuehn)

🚀 Type: New Feature

• gatsby-theme-docs
  • #367 feat: release notes link to rss and product newsletter (@davifantasia)
  • #364 feat: generate rss feed (@davifantasia)
  • #339 feat(release-notes): create gatsby nodes for release notes frontmatter fields (@davifantasia)
• gatsby-theme-docs, ui-kit
  • #352 Release notes list design implementation (@davifantasia)
• gatsby-theme-api-docs, gatsby-theme-docs
  • #336 feat(theme): implement release notes page layout (@emmenko)

⛑ Type: Refactoring

• gatsby-theme-docs
  • #369 refactor(theme): to customize Stamp using theme (@emmenko)
  • #365 refactor: release notes left over (@davifantasia)
• gatsby-theme-api-docs, gatsby-theme-docs, gatsby-transformer-mdx-introspection, gatsby-transformer-raml-legacy, gatsby-transformer-raml, ramldoc-generator, ui-kit
  • #355 refactor(theme): use uikit Stamp component for release note types (@emmenko)

🤖 Type: Dependencies

• writing-style
  • #366 Writing Style Linter: Update vale and prevent binary from being published (@nkuehn)
• ramldoc-generator
  • #343 fix(deps): update dependency chalk to v4 (@renovate[bot])

v2.4.0

2.4.0 (2020-04-03)

🐛 Type: Bug

• gatsby-theme-api-docs
  • #330 fix: query parameters types that are objects now render as links (@davifantasia)
• writing-style
  • #333 fix(writing-style): cover the last few cases from the existing docs (@nkuehn)

🔮 Type: Chore

• gatsby-theme-docs
  • #334 chore: update cookie consent banner script (@nkuehn)

🚀 Type: New Feature

• gatsby-theme-docs

  • #332 feat(theme): set up release notes template (@davifantasia)

  This feature is still under development.

🤖 Type: Dependencies

• gatsby-theme-api-docs, gatsby-theme-docs
  • #326 chore(deps): update all dependencies (major) (@renovate[bot])

v2.3.0

2.3.0 (2020-03-30)

🐛 Type: Bug

• writing-style
  • #323 feat(writing-style): upgrade to vale 2.1.0, don't let vale fail when called from the VSCode plugin (@nkuehn)
• gatsby-transformer-mdx-introspection
  • #324 fix: appropriate async implementation for gatsby (@davifantasia)

🚀 Type: New Feature

• gatsby-theme-docs, ui-kit

  • #325 feat(theme): add support for specifying new languages for Prism (@emmenko)

  You can now pass a new option availablePrismLanguages to the theme config, which is a list of strings. This is useful in case you need to include Prism languages that are not included by default by prism-react-renderer.

⛑ Type: Refactoring

• writing-style
  • #323 feat(writing-style): upgrade to vale 2.1.0, don't let vale fail when called from the VSCode plugin (@nkuehn)