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
.
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: {
// ...
},
},
],
}),
],
};
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
broken-link-checker
gatsby-theme-docs
gatsby-theme-api-docs
,gatsby-theme-code-examples
,gatsby-theme-docs
gatsby-theme-api-docs
writing-style
- #410 WIP writing style: adjustments (@adinakleine)
- Other
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
gatsby-theme-docs
,ui-kit
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
gatsby-theme-code-examples
,gatsby-theme-docs
,gatsby-transformer-code-examples
gatsby-theme-api-docs
gatsby-theme-api-docs
,gatsby-theme-docs
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])
2.5.0 (2020-04-17)
gatsby-theme-docs
,gatsby-transformer-code-examples
writing-style
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)
gatsby-theme-docs
writing-style
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
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
writing-style
ramldoc-generator
- #343 fix(deps): update dependency chalk to v4 (@renovate[bot])
2.4.0 (2020-04-03)
gatsby-theme-api-docs
- #330 fix: query parameters types that are objects now render as links (@davifantasia)
writing-style
-
gatsby-theme-docs
- #332 feat(theme): set up release notes template (@davifantasia)
This feature is still under development.
gatsby-theme-api-docs
,gatsby-theme-docs
- #326 chore(deps): update all dependencies (major) (@renovate[bot])
2.3.0 (2020-03-30)
writing-style
gatsby-transformer-mdx-introspection
- #324 fix: appropriate async implementation for gatsby (@davifantasia)
-
gatsby-theme-docs
,ui-kit
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 byprism-react-renderer
.
writing-style
2.2.0 (2020-03-25)
gatsby-theme-docs
,ui-kit
- #305 feat(theme): implement and components (@davifantasia)
Documentation writers can now reference multiple code examples together in the MDX files. The code examples are grouped together and enables users to switch between them via a dropdown. This is useful when there is a need to provide examples that achieve the same thing in different programming languages.
<MultiCodeExample title="Multilanguage Code Samples">
<CodeExample path="example.js" highlightLines={[3]} />
<CodeExample path="example.java"/>
<CodeExample path="example.console" noPromptLines={[3, 4]} />
</MultiCodeExample>
The code example files are expected to be saved in src/code-examples
.
2.1.0 (2020-03-23)
gatsby-theme-docs
,gatsby-transformer-code-examples
,ui-kit
,writing-style
- #304 feat: code examples provided on graphQL by a transformer plugin (@davifantasia)
broken-link-checker
,gatsby-theme-api-docs
,gatsby-theme-docs
,gatsby-transformer-mdx-introspection
,gatsby-transformer-raml-legacy
,gatsby-transformer-raml
,ramldoc-generator
,ui-kit
,writing-style
- #316 chore(deps): update dependency prettier to v2 and babel to v7.9 (@renovate[bot])
gatsby-theme-docs
- #307 fix(deps): update dependency rehype-slug to v3 (@renovate[bot])
- Other
- #306 chore(deps): bump acorn from 6.4.0 to 6.4.1 (@dependabot[bot])
- #301 chore(deps): update all dependencies (major) (@renovate[bot])
2.0.0 (2020-03-12)
This release introduces some breaking changes, as documented below.
The plugin got an internal re-write and the API changed a bit.
One key area in which it is different is the casing of JSX attributes/tags. This is due to dropping the HTML parsing engine, which automatically converted the case. Now, all components/attributes will use the source casing from the compiled MDX, which is usually Pascal/camelCase.
More detailed information can be found in the package README, as well as the list of supported options.
gatsby-theme-api-docs
,gatsby-transformer-mdx-introspection
- #183 feat(introspection): utilize Babel parser to better parse MDX into component nodes (@jazevedo620)
gatsby-theme-api-docs
,ramldoc-generator
- #296 feat: add ramldoc-generator package (@davifantasia)
The new package @commercetools-docs/ramldoc-generator
provides an executable to transform any spec-compliant RAML API definition into the (also RAML-compliant) RAML document structure and layout required by the @commercetools-docs/gatsby-transformer-raml plugin.
1.8.1 (2020-02-21)
1.8.0 (2020-02-19)
gatsby-theme-docs
- Other
- #282 chore(deps): update all dependencies (major) (@renovate[bot])
gatsby-theme-api-docs
,gatsby-theme-docs
- #283 chore(deps): lock file maintenance all dependencies (@renovate[bot])
1.7.7 (2020-02-17)
- #281 fix(actions): check out with depth 50 to allow proper canary versions on master branch (@emmenko)
- #280 fix: publish canary only if lerna detects that packages changed (@emmenko)
1.7.6 (2020-02-07)
gatsby-theme-docs
gatsby-theme-api-docs
,gatsby-transformer-raml
- #272 refactor: enhanced graphql for resources (@davifantasia)
- #271 refactor: expose gatsby-transformer-raml options (@davifantasia)
- Other
- #270 chore(deps): lock file maintenance (@renovate[bot])
- #269 chore(deps): update dependency eslint-plugin-testing-library to v2 (@renovate[bot])
gatsby-theme-api-docs
,gatsby-theme-docs
,ui-kit
- #268 chore(deps): update all dependencies (@renovate[bot])
1.7.5 (2020-02-03)
gatsby-theme-docs
1.7.4 (2020-02-02)
gatsby-theme-docs
gatsby-theme-api-docs
,gatsby-transformer-raml
- #257 fix: import api bugs (@davifantasia)
gatsby-theme-docs
,ui-kit
1.7.3 (2020-01-31)
gatsby-theme-docs
,ui-kit
1.7.2 (2020-01-29)
1.7.1 (2020-01-29)
writing-style
gatsby-theme-api-docs
- #245 fix: union type failed to render since it has examples (@davifantasia)
gatsby-theme-docs
,ui-kit
gatsby-theme-docs
,writing-style
gatsby-theme-api-docs
- #239 refactor: move components one level up (@davifantasia)
- Other
- #238 chore(deps): lock file maintenance (@renovate[bot])
- #237 chore(deps): update all dependencies (major) (@renovate[bot])
gatsby-theme-api-docs
,gatsby-theme-docs
- #236 chore(deps): update all dependencies (@renovate[bot])
1.7.0 (2020-01-24)
gatsby-theme-docs
gatsby-theme-api-docs
,gatsby-transformer-raml
- #220 fix: missing
gatsby-transformer-raml
dependency version (@davifantasia) - #219 fix: path to RAML spec (@davifantasia)
- #220 fix: missing
NOTE that the
gatsby-theme-api-docs
had some unexpected breaking changes inv1.5.0
(#194), which are now fixed. We recommend to look at thewebsites/api-docs-smoke-test
folder to check and compare the new setup.
gatsby-theme-api-docs
- #224 Type design implementation (@davifantasia)
- #222 Method design implementation (@davifantasia)
gatsby-theme-docs
gatsby-theme-docs
,ui-kit
ui-kit
gatsby-theme-api-docs
- #228 Resource design implementation (@davifantasia)
broken-link-checker
,gatsby-theme-api-docs
,gatsby-theme-docs
,gatsby-transformer-mdx-introspection
,ui-kit
- #215 chore(deps): update all dependencies (@renovate[bot])
- Other
- #216 chore(deps): update all dependencies (major) (@renovate[bot])
- #217 chore(deps): lock file maintenance (@renovate[bot])
1.6.0 (2020-01-17)
1.5.0 (2020-01-16)
gatsby-theme-docs
,ui-kit
gatsby-theme-api-docs
- #206 Parameters design implementation (@davifantasia)
gatsby-theme-api-docs
,gatsby-transformer-raml
- #202 Rendering resources based on RMF codegen (@davifantasia)
- #194 gatsby-transformer-raml based on Rmf codegen (@davifantasia)
- Other
- #204 chore(deps): update all dependencies (major) (@renovate[bot])
- #205 chore(deps): lock file maintenance (@renovate[bot])
- #193 chore(deps): lock file maintenance (@renovate[bot])
- #192 chore(deps): update dependency stylelint-order to v4 (@renovate[bot])
- #191 chore(deps): update cypress/base docker tag to v12.14.0 (@renovate[bot])
gatsby-theme-api-docs
,gatsby-theme-docs
- #203 chore(deps): update all dependencies (@renovate[bot])
gatsby-theme-api-docs
,gatsby-theme-docs
,ui-kit
- #190 chore(deps): update all dependencies (@renovate[bot])
1.4.1 (2020-01-02)
Happy New Year! 🎉
gatsby-theme-docs
- #185 chore(deps): update all dependencies (@renovate[bot])
- Other
- #186 chore(deps): lock file maintenance (@renovate[bot])
1.4.0 (2019-12-27)
gatsby-theme-docs
gatsby-theme-docs
- #181 chore(deps): update all dependencies (major) (@renovate[bot])
broken-link-checker
,gatsby-theme-api-docs
,gatsby-theme-docs
,gatsby-transformer-mdx-introspection
- #180 chore(deps): update all dependencies (@renovate[bot])
- Other
- #182 chore(deps): lock file maintenance (@renovate[bot])
- #166 chore(deps): update dependency stylelint-config-prettier to v8 (@renovate[bot])
- #167 chore(deps): lock file maintenance (@renovate[bot])
gatsby-theme-api-docs
,gatsby-theme-docs
,ui-kit
- #165 chore(deps): update all dependencies (@renovate[bot])
1.3.2 (2019-12-13)
1.3.1 (2019-12-13)
1.3.0 (2019-12-13)
We added a new package @commercetools-docs/ui-kit
that contains the low-level UI components used to build the documentation website.
If you need to use some of these components, you can use do that directly using the package. Previously some of those components were exposed from the @commercetools-docs/gatsby-theme-docs
. For backwards compatibility, all exports of @commercetools-docs/ui-kit
are exposed on the @commercetools-docs/gatsby-theme-docs
package as well.
gatsby-theme-docs
gatsby-theme-api-docs
,gatsby-theme-docs
,ui-kit
broken-link-checker
gatsby-theme-docs
gatsby-theme-api-docs
1.2.1 (2019-12-12)
1.2.0 (2019-12-12)
gatsby-theme-api-docs
,gatsby-theme-docs
,gatsby-transformer-mdx-introspection
broken-link-checker
1.1.0 (2019-12-11)
gatsby-theme-docs
1.0.5 (2019-12-10)
1.0.4 (2019-12-10)
broken-link-checker
1.0.3 (2019-12-10)
gatsby-theme-docs
writing-style
1.0.2 (2019-12-09)
1.0.1 (2019-12-06)
The following packages had problems being published in the previous version.
@commercetools-docs/gatsby-transformer-mdx-introspection
@commercetools-docs/gatsby-transformer-raml-legacy
1.0.0 (2019-12-06)
This is the first "official" release after the initial development. From now we will update the changelog on every new release.
There isn't an official changelog prior to this version.