Releases: peterdesmet/petridish
Releases · peterdesmet/petridish
Version 3.0
Blog posts
- Breaking! Posts now use
tags
instead ofcategories
. Usetags: [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) andbackground.img: path/url to image
. The attribution will appear on the bottom right corner. The originalbackground: path/url to image
will continue to work. - Disqus comments can now be configured.
Top navigation
- 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 usinghref
only, thetext
will be assigned based on the page title at that link. You can still usetext
to overwrite a title (e.g. a shorter one better fit for the navigation).
Footer
- Breaking! Social links are now grouped into
social
in_config.yml
. The oldemail
,github_username
andtwitter_username
will continue to work in this version, but might be removed in future versions. social.github
can either be agithub_username
or agithub_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 anEdit this page
link in the footer.
Team page
- You can now create multiple team pages.
googlescholar
andmastodon
socials can now be defined for team members.
Metadata
- Breaking!
site.description
(in_config.yml
) is no longer used in<head>
metadata. Instead, the page/post description is used. <head>
now includespage.author
if defined<head>
now includes Open Graph Protocol metadata, i.e.og:url
,og:type
,og:title
,og:description
andog: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.
Style
- 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
Version 2.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
tofloat-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 thanbadge-secondary
.
- Updates Font Awesome to v5.
- If you use Font Awesome CSS classes in your content, you will have to update
fa
tofas
(solid icon),far
(regular outline icon) orfab
(brand icon). E.g.fa fa-github
tofab fa-github
- If you use Font Awesome CSS classes in your content, you will have to update
- 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.
Version 1.1
Fix some issues: 1.0...1.1
Version 1.0
First version that I'm happy to use for production. 🧫