Releases · peterdesmet/petridish

Blog posts

Breaking! Posts now use tags instead of categories. Use tags: [tag 1, tag 2] in post front matter.
You can credit the creator of background images by using background.by: name, background.href: url (attribution link) and background.img: path/url to image. The attribution will appear on the bottom right corner. The original background: path/url to image will continue to work.
Disqus comments can now be configured.

Sites with a lot of content can now assign a custom navigation for certain sections.
It is no longer required to define the title (text) of pages in the navigation. By using href only, the text will be assigned based on the page title at that link. You can still use text to overwrite a title (e.g. a shorter one better fit for the navigation).

Breaking! Social links are now grouped into social in _config.yml. The old email, github_username and twitter_username will continue to work in this version, but might be removed in future versions.
social.github can either be a github_username or a github_username/repository
You can now include links to Facebook and Mastodon. The Mastodon link will support site verification (see your Mastodon profile settings).
When archive_permalink is enabled, the footer will include an RSS icon.
A new option github_edit: true / branch name enables an Edit this page link in the footer.

Breaking! site.description (in _config.yml) is no longer used in <head> metadata. Instead, the page/post description is used.
<head> now includes page.author if defined
<head> now includes Open Graph Protocol metadata, i.e. og:url, og:type, og:title, og:description and og:image. This results in better preview when linking a page/post on Mastodon, Twitter, etc.
The site logo and background images now have an alt attribute.

The title (h1) and description (lead) in the header are now slightly smaller for better readability on small screens.
Navigation dropdowns are now aligned to the right to avoid them being cut off.
Tables are now wrapped in a div with table-responsive avoiding them to break out their parent container.
Breaking! Some of your custom _layouts might be affected.
Long table of contents can now be scrolled.

Full changelog: 2.0...3.0

Updates Bootstrap to v5.
- New layout for tables is likely the most visible change.
- Petridish keeps underline reserved for hoovered links.
- If you use Bootstrap CSS classes in your content, note that some have been renamed. Most notably float-left/float-right to float-start/float-end (but an alias in Petridish will make sure those continue to work) and badge colours now use e.g. bg-secondary rather than badge-secondary.
Updates Font Awesome to v5.
- If you use Font Awesome CSS classes in your content, you will have to update fa to fas (solid icon), far (regular outline icon) or fab (brand icon). E.g. fa fa-github to fab fa-github
You can now use a sans-serif font for content (font_serif: false in _config.yml).
You can now enable Disqus comments for posts (comments: true in post frontmatter).
You can now enable a table of content for pages or posts (toc: true in page frontmatter).
Documentation is divided in Installation, Configuration and Markdown.
Favicon now works for sites on a subdomain.