Releases: bensmithett/tropical
6.2.0: Make meta description optional
Changes
See #16
Upgrade instructions (more info)
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
- Update
DefaultLayout
(or your own layouts) to makemeta.description
optional as per #16 - If you were including a
meta.description
on any pages and you didn't really want to, remove it! - If you're using Prettier, copy the changes to
.prettierrc
from #16 (although I'm not the boss of you, configure Prettier however you want!)
6.1.0: Syntax highlighting and a better CSS reset
Changes
See #15
- Adds Prism-powered syntax highlighting for fenced code blocks in Markdown content, as per the MDX docs
- As a result, there's also a new
CodeBlock
component that can be used independently of Markdown if necessary
- As a result, there's also a new
- Minor improvements to the CSS reset (see #15)
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
Syntax highlighting
- Add a couple of new dependencies:
yarn add @mdx-js/react prism-react-renderer
- Copy the new
CodeBlock
component into yourcomponents
folder - Add the
MDXProvider
component to thebuildPageFile
function inprerender.js
https://github.com/bensmithett/tropical/pull/15/files#diff-36c4430d199533126f4c93fec3350cbdR90-R95 - Optionally, enable some extra Prism languages https://github.com/bensmithett/tropical/pull/15/files#diff-36c4430d199533126f4c93fec3350cbdR180-R185
CSS Reset
Copy the simple changes to cssReset.js
from #15 https://github.com/bensmithett/tropical/pull/15/files#diff-de01364995b305a01639d43eb475345b
6.0.1: Minor dependency updates
Changes
Minor dependency updates
Upgrade instructions (more info)
yarn upgrade @babel/core @babel/preset-env @babel/preset-react @mdx-js/loader webpack
6.0.0: 🐍 🔜 🐪
Changes
- Changed filenames from snake_case to more JS-ish camelCase/TitleCase
- Bumped the default version of Node from 12.16.0 to 14.5.0
- More documentation
- Added a
.prettierrc
Upgrade instructions (more info)
- Sorry, this is an annoying upgrade. There's no functionality change in here, but you may want to rip the bandaid off and do a bulk rename of files as per #12.
- Alternatively, if you haven't made changes to the core files you can just copy your
components
andpages
into this new version rather than renaming everything.
- Alternatively, if you haven't made changes to the core files you can just copy your
- Start using Node 14.5.0 for this project
- Copy
.prettierrc
if you wish to use it
5.0.0: A new name
4.0.0: Buzzword swap!
Changes
- Replaces use of isomorphic with hydration, since that's what the concept is called in React now
- Add some more inline READMEs to help when starting out.
- Move document template from its own file to
entry.prerender.js
Upgrade instructions (more info)
As per the diff in #10
- Delete
layouts/document_template.js
and put its contents inentry.prerender.js
- Rename
isomorphic_helpers.js
tohydration_helpers.js
and update references - Rename
rehydrateIslands
tohydrateIslands
and update references
3.0.0: The Neatening
Changes
Moves the following folders into an app
folder:
components
images
layouts
pages
as well as the four core San Blas files (previously in lib
)
build.js
entry.client.js
entry.prerender.js
isomorphic_helpers.js
and update references to the new paths.
Upgrade instructions (more info)
- Move the folders and files above into an
app
folder - Update references and imports to reflect the new project structure
- See https://github.com/bensmithett/sanblas/pull/9/files for a starting point (I had to update 5 files)