11.4.2: Fix feed rendering

Changes

• Add missing meta and tableOfContents props that weren't being passed to pages when rendered for the JSON Feed 12a44c8

Diff: v11.4.1...v11.4.2

Upgrade instructions (more info)

Merge upstream changes

First, configure this repo as a remote for your repo (you only need to do this once)

  git remote add template https://github.com/bensmithett/tropical.git

Then fetch & merge the latest changes, resolving any conflicts manually:

git fetch template
git merge template/main

or...

Manually update your code

Merging upstream changes should be straightforward for this change but see v11.4.1...v11.4.2 for changes you can make to your project manually.

As always, open an issue if you're having trouble upgrading and I'll help you through it!

11.4.1

Changes

• Update dependencies to latest versions
• Fix a React warning about missing key in TableOfContents

Diff: v11.4.0...v11.4.1

Upgrade instructions (more info)

Merge upstream changes

First, configure this repo as a remote for your repo (you only need to do this once)

  git remote add template https://github.com/bensmithett/tropical.git

Then fetch & merge the latest changes, resolving any conflicts manually:

git fetch template
git merge template/main

or...

Manually update your code

Merging upstream changes should be straightforward for this change but see v11.4.0...v11.4.1 for changes you can make to your project manually.

As always, open an issue if you're having trouble upgrading and I'll help you through it!

11.4.0: Tables of contents

Changes

• Extract a table of contents from MDX pages (based on heading slugs)
  • Add @stefanprobst/rehype-extract-toc Rehype plugin and configure in Vite config
  • Update entry-server.jsx to pass extracted tableOfContents data as props to Layout and Page components
  • Add a very basic <TableOfContents> component & stories

Diff: #52

Upgrade instructions (more info)

Merge upstream changes

First, configure this repo as a remote for your repo (you only need to do this once)

  git remote add template https://github.com/bensmithett/tropical.git

Then fetch & merge the latest changes, resolving any conflicts manually:

git fetch template
git merge template/main

or...

Manually update your code

Merging upstream changes should be straightforward for this change but see v11.3.0...v11.4.0 for changes you can make to your project manually.

As always, open an issue if you're having trouble upgrading and I'll help you through it!

11.3.0: GitHub Flavored Markdown

Changes

• #51 default to using GitHub Flavored Markdown in MDX files (as per https://mdxjs.com/guides/gfm/)

Diff: https://github.com/bensmithett/tropical/pull/51/files

Upgrade instructions (more info)

Merge upstream changes

First, configure this repo as a remote for your repo (you only need to do this once)

  git remote add template https://github.com/bensmithett/tropical.git

Then fetch & merge the latest changes, resolving any conflicts manually:

git fetch template
git merge template/main

or...

Manually update your code

Merging upstream changes should be straightforward for this change (unless you've made lots of changes to Vite config or TropicalCodeBlock) but see v11.2.0...2f0b51a for changes you can make to your project manually.

As always, open an issue if you're having trouble upgrading and I'll help you through it!

11.2.0: Responsive images

Changes

Diff: v11.1.0...a031636

• Add and configure vite-plugin-image-presets (from Tropical's Vue-flavoured cousin îles!)
• Add <Image> and <Picture> components that work with those preset imports

See the new Images docs for usage details.

Upgrade instructions (more info)

Merge upstream changes

First, configure this repo as a remote for your repo (you only need to do this once)

  git remote add template https://github.com/bensmithett/tropical.git

Then fetch & merge the latest changes, resolving any conflicts manually:

git fetch template
git merge template/main

or...

Manually update your code

Merging upstream changes should be straightforward for this change (unless you've made lots of changes to Vite config or TropicalCodeBlock) but see v11.1.0...a031636 for changes you can make to your project manually.

As always, open an issue if you're having trouble upgrading and I'll help you through it!

11.1.0: Enable pnpm & npm alongside yarn

Changes

See v11.0.0...c42f0be

• Add yarpm and update package scripts to call it instead of yarn
• Rename TropicalPhotoButton to ExampleComponent
• Fix a build script bug (it wasn't using the correct Vite config following the v11.0.0 updates)

Upgrade instructions (more info)

Merge upstream changes

First, configure this repo as a remote for your repo (you only need to do this once)

  git remote add template https://github.com/bensmithett/tropical.git

Then fetch & merge the latest changes, resolving any conflicts manually:

git fetch template
git merge template/main

or...

Manually update your code

Merging upstream changes should be straightforward for this change (unless you've made lots of changes to Vite config or TropicalCodeBlock) but see v11.0.0...c42f0be for changes you can make to your project manually.

As always, open an issue if you're having trouble upgrading and I'll help you through it!

11.0.0: Vite 3, React 18, MDX 2 and Ladle!

Changes

See #48

• Upgrade dependencies
  • Vite 2.0 to 3.0
  • React 17 to 18.2
  • MDX 1.x to 2.1
• Replace Storybook with Ladle
  • See #47 for rationale
• Move components/TropicalCodeBlock to components/tropical/CodeBlock
  • The next release is going to have another "batteries included" Tropical component (a responsive <Picture>). I figured I should put these in a special folder instead of mixing them in with your components.

Upgrade instructions (more info)

Merge upstream changes

First, configure this repo as a remote for your repo (you only need to do this once)

  git remote add template https://github.com/bensmithett/tropical.git

Then fetch & merge the latest changes, resolving any conflicts manually:

git fetch template
git merge template/master

or...

Manually update your code

Merging upstream changes should be straightforward for this change (unless you've made lots of changes to Vite config or TropicalCodeBlock) but see https://github.com/bensmithett/tropical/pull/48/files for changes you can make manually:

• Update package.json dependencies and scripts as per https://github.com/bensmithett/tropical/pull/48/files#diff-7ae45ad102eab3b6d7e7896acd08c427a9b25b346470d7bc6507b6481575d519
• Add .ladle/components.jsx https://github.com/bensmithett/tropical/pull/48/files#diff-67c18fdc9866dc95181e2a2c0dde801941f0c869f5c108e553e43146daab1a40
• Delete the .storybook folder
• Update server.js so it works with Vite 3 https://github.com/bensmithett/tropical/pull/48/files#diff-a4c65ede64197e1a112899a68bf994485b889c4b143198bac4af53425b38406f
• Rename components/TropicalCodeBlock to components/tropical/CodeBlock
  • and update the reference in entry-server.jsx
• Convert any MDX stories to CSF
  • Ladle doesn't support MDX stories yet but it's coming soon. If you like your MDX stories, you may want to wait for that update.
• Make sure you have 3 Vite config files as per #48
  • vite.config.js - contains shared config used for both the server and client builds (and is picked up by Ladle)
  • vite.config.server.js
  • vite.config.client.js

As always, open an issue if you're having trouble upgrading and I'll help you through it!

10.2.0: Simpler syntax highlighting

Changes

See #45

Upgrade instructions (more info)

Merge upstream changes

First, configure this repo as a remote for your repo (you only need to do this once)

  git remote add template https://github.com/bensmithett/tropical.git

Then fetch & merge the latest changes, resolving any conflicts manually:

git fetch template
git merge template/master

or...

Manually update your code

Merging upstream changes should be easy for this change (unless you've made lots of changes to TropicalCodeBlock) but see https://github.com/bensmithett/tropical/pull/45/files for changes you can make manually:

• yarn remove prism-react-renderer && yarn add react-syntax-highlighter
• Update TropicalCodeBlock and entry-server.jsx as per #45
• Add "framework": "@storybook/react" to your .storybook/main.cjs
• Add providerImportSource: '@mdx-js/react' to both vite config files

10.1.0: Fix broken asset hashing

Changes

See #44

10.0.0 switched from a 2-step prerender (build the server bundle, then import & use it) to one step (import the Renderer directly into the prerenderer with vite.ssrLoadModule)

However as raised in #42, that meant some assets were being referenced by their original name rather than the cacheable hashed name.

This change switches back to the 2-step prerender, while keeping 10.0.0's switch to ES Modules at the project level.

Upgrade instructions (more info)

Merge upstream changes

First, configure this repo as a remote for your repo (you only need to do this once)

  git remote add template https://github.com/bensmithett/tropical.git

Then fetch & merge the latest changes, resolving any conflicts manually:

git fetch template
git merge template/master

or...

Manually update your code

Merging upstream changes should be easy for this change, but see https://github.com/bensmithett/tropical/pull/44/files for changes you can make manually:

• Update the build and build:server scripts in package.json
• In prerender.js, switch vite.ssrLoadModule for import and remove references to vite
• Add the new vite.config.server.js

10.0.1: Upgrade to Fela 12

Changes

Major Fela update but shouldn't require any changes to your app code. See https://github.com/robinweser/fela/releases/tag/v12.0.1 and https://weser.io/blog/introducing-fela-12

Upgrade instructions (more info)

Merge upstream changes

First, configure this repo as a remote for your repo (you only need to do this once)

  git remote add template https://github.com/bensmithett/tropical.git

Then fetch & merge the latest changes, resolving any conflicts manually:

git fetch template
git merge template/master

or...

Manually update your code

See https://github.com/bensmithett/tropical/pull/43/files, you'll need to:

• yarn upgrade-interactive and upgrade the outdated dependencies but be careful to exclude
  • @mdx-js/mdx
  • @mdx-js/react
  • react
  • react-dom

React 18 has just been released but some Storybook dependencies need to catch up before we upgrade that.

The upgrade to MDX 2 appears to be blocked at the moment while Storybook is still dependent on MDX 1, see storybookjs/builder-vite#234 and brillout/vite-plugin-mdx#47