v2.2.0

2.2.0 (2020-03-25)

🚀 Type: New Feature

• 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.

v2.1.0

2.1.0 (2020-03-23)

🔮 Type: Chore

• gatsby-theme-docs
  • #311 fix(theme): remove duplicated source filesystem config (@emmenko)

🚀 Type: New Feature

• gatsby-theme-docs, gatsby-transformer-code-examples, ui-kit, writing-style
  • #304 feat: code examples provided on graphQL by a transformer plugin (@davifantasia)

🤖 Type: Dependencies

• 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])

v2.0.0

2.0.0 (2020-03-12)

This release introduces some breaking changes, as documented below.

Changes in gatsby-transformer-mdx-introspection

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.

💥 Type: Breaking Change

• gatsby-theme-api-docs, gatsby-transformer-mdx-introspection
  • #183 feat(introspection): utilize Babel parser to better parse MDX into component nodes (@jazevedo620)

🚀 Type: New Feature

• 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.

v1.8.1

1.8.1 (2020-02-21)

🐛 Type: Bug

• gatsby-theme-docs
  • #293 fix(theme): css overrides for search overlay (@emmenko)

v1.8.0

1.8.0 (2020-02-19)

🚀 Type: New Feature

• gatsby-theme-docs
  • #175 feat(theme): restore scroll position of main navigation links, when navigating to a new page (@emmenko)

🤖 Type: Dependencies

• 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])

v1.7.7

1.7.7 (2020-02-17)

🔮 Type: Chore

• #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)

⛑ Type: Refactoring

• gatsby-theme-docs, ui-kit
  • #288 refactor: rendering of code block for syntax highlighting (@emmenko)

v1.7.6

1.7.6 (2020-02-07)

⛑ Type: Refactoring

• gatsby-theme-docs
  • #277 refactor: use more semantic HTML elements for the search crawler (@nkuehn)
• gatsby-theme-api-docs, gatsby-transformer-raml
  • #272 refactor: enhanced graphql for resources (@davifantasia)
  • #271 refactor: expose gatsby-transformer-raml options (@davifantasia)

🤖 Type: Dependencies

• 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])

v1.7.5

1.7.5 (2020-02-03)

🐛 Type: Bug

• gatsby-theme-docs
  • c7dd89f fix(theme): ensure css overwrites default one for top menu position (@emmenko)

⛑ Type: Refactoring

• gatsby-theme-docs
  • #273 refactor(theme): sync top menu links (@emmenko)

v1.7.4

1.7.4 (2020-02-02)

🐛 Type: Bug

• gatsby-theme-docs
  • #266 fix(theme): to use correct selector to exclude style elements (@emmenko)
  • #265 fix(theme): to patch lobotomized owl selector to ignore style children (@emmenko)
  • #260 fix(theme): sidebar link border color (@emmenko)
• gatsby-theme-api-docs, gatsby-transformer-raml
  • #257 fix: import api bugs (@davifantasia)
• gatsby-theme-docs, ui-kit
  • #261 fix(theme): use data-link-type instead of aria role attribute (@emmenko)

v1.7.3

1.7.3 (2020-01-31)

🔮 Type: Chore

• gatsby-theme-docs
  • #258 chore(theme): enable custom apps link in top menu (@emmenko)

💅 Type: Enhancement

• gatsby-theme-docs, ui-kit
  • #253 refactor(theme): to make the link underline style configurable via a prop (@emmenko)