Last alpha release
Toucan 1.0.0-alpha.3 is now released, this article will help you to understand the changes and to migrate your site from alpha 2.
The alpha testing phase for Toucan is now finished with the release of the final alpha version, 1.0.0-alpha.3. We are preparing to begin the beta release cycle shortly.
Migration guide & docs
Toucan 1.0.0-alpha.3 introduces several changes. The documentation has been updated to reflect these updates. Here’s a step-by-step guide on how to update your existing website to reflect the changes.
Content changes
- Move the
src/typesfolder intothemes/default/directory. - Rename the
src/contentfolder tosrc/contents. - Move the
index.mdfile tohome/index.md. - Create a new
index.ymlfile in thecontentsdirectory. - Move out the site section from your
config.ymlfile to this newly created
siteindex.ymlfile, e.g.:
baseUrl: "https://mywebsite.com/"
language: "en-US"
title: "My website"
description: "This is my personal website."
dateFormat: "yyyy.MM.dd."
navigation:
- label: "Home"
url: "/"
- label: "About"
url: "/docs/"
Config changes
If you were using the content transformer feature, move the content-type transformer configuration into the config.yml file:
transformers:
pipelines:
# run the following scripts for post the type
post:
run:
- name: swiftinit
# indicates that the result is already HTML
isMarkdownResult: false # default: true
Otherwise if you had no special configuration, feel free to completely remove the config file, to use the defaults.
Theme changes
- Move the
index.mustachefile topages/home.mustache. - Move the
404.mustachefile topages/404.mustache. - Move the
pages/single/page.mustachefile topages/default.mustache. - Update / remove the
template:front matter key in your home and not found page. - Rename the
blocksfolder topartials, this is the recommended name now. - Search for
{{> blocksand replace with{{> partialsin the template files.
Follow the same logic for for all your custom types, e.g.:
blog.index->blog.homeblog.authors.index->blog.authorsblog.single.tag->blog.tag.defaultblog.blocks->partials.blog{{> blog.blocks->{{> partials.blog
That’s all you need to do to support the latest alpha release. Feel free to explore the sample repositories, all of which are up-to-date with the recent changes:
We hope you enjoy using Toucan, and your feedback is greatly appreciated. 🙏
Related articles
Toucan SGG enters the release candidate phase
After multiple alpha and beta releases, Toucan, the Swift-based static site generator, has entered its Release Candidate phase.
Beta 5 is now available
The fifth beta release of Toucan is now available. This release includes many improvements and some new features.
Beta 3 is out
The third beta release of Toucan is now ready try. New pipelines, queries, iterators and more.