zola/CHANGELOG.md

307 lines
13 KiB
Markdown
Raw Normal View History

2017-03-27 02:48:01 +00:00
# Changelog
2018-12-27 09:49:32 +00:00
## 0.6.0 (unreleased)
### Breaking
- `earlier/later` and `lighter/heavier` are not set anymore on pages when rendering
a section
- The table of content for a page/section is now only available as the `toc` variable when
rendering it and not anymore on the `page`/`section` variable
2019-03-11 19:21:13 +00:00
- Default directory for `load_data` is now the root of the site instead of the `content` directory
2019-03-14 20:15:01 +00:00
- Change variable sent to the sitemap template, see documentation for details
### Other
2018-12-28 09:42:26 +00:00
- Add support for content in multiple languages
2019-01-05 10:02:46 +00:00
- Lower latency on serve before rebuilding from 2 to 1 second
- Allow processing PNG and produced images are less blurry
2019-01-17 17:18:02 +00:00
- Add an id (`zola-continue-reading`) to the paragraph generated after a summary
- Add Dracula syntax highlighting theme
- Fix using inline styles in headers
- Fix sections with render=false being shown in sitemap
2019-03-19 19:42:16 +00:00
- Sitemap is now split when there are more than 30 000 links in it
2019-03-14 20:30:53 +00:00
- Add link to sitemap in robots.txt
- Markdown rendering is now fully CommonMark compliant
- `load_data` now defaults to loading file as plain text, unless `format` is passed
or the extension matches csv/toml/json
2019-03-19 19:42:16 +00:00
- Sitemap entries get an additional `extra` field for pages only
2019-01-17 17:18:02 +00:00
2018-12-27 09:49:32 +00:00
2018-12-14 16:13:24 +00:00
## 0.5.1 (2018-12-14)
2018-11-19 16:19:05 +00:00
- Fix deleting markdown file in `zola serve`
- Fix pagination for taxonomies being broken and add missing documentation for it
- Add missing pager pages from the sitemap
- Allow and parse full RFC339 datetimes in filenames
2018-12-10 17:21:08 +00:00
- Live reload is now enabled for the 404 page on serve
2018-11-19 16:19:05 +00:00
2018-11-17 14:05:35 +00:00
## 0.5.0 (2018-11-17)
2018-09-05 15:26:39 +00:00
2018-09-30 21:49:32 +00:00
### Breaking
- Gutenberg has changed name to `zola`!
2018-09-30 21:49:32 +00:00
- The `pagers` variable of Paginator objects has been removed
- `section.subsections` is now an array of paths to be used with the `get_section`
Tera function
2018-10-18 15:20:51 +00:00
- Table of content now strips HTML from the titles to avoid various issues
- `gutenberg-anchor` CSS class has been renamed `zola-anchor`
2018-11-16 22:51:11 +00:00
- `data` is now a reserved variable name in templates, it is unused right now but
might change soon.
2018-09-30 21:49:32 +00:00
### Others
- Many many times faster (x5-x40) for most sites
2018-09-09 17:43:14 +00:00
- Update dependencies, fixing a few bugs with templates
- Load only .html files in themes from the templates folder
- Background colour is set fewer times when highlighting syntaxes, resulting in smaller HTML filesize
- Link checker will not try to validate email links anymore
- Load table and footnote markdown extensions in `markdown` filter
- `get_url` now defaults to not adding a trailing slash
- Fix `--base-url` not overriding processed images URLs
- Add more Emacs temp file to the ignored patterns in `gutenberg serve`
- Files starting with `.` are not considered pages anymore even if they end with `.md`
2018-09-15 11:16:46 +00:00
- `_processed_images` folder for image processing has been renamed `processed_images` to avoid issues with GitHub Pages
- Syntax highlighting default was mistakenly `true`, it has been set to `false`
2018-09-29 09:20:59 +00:00
- Add NO_COLOR and CLICOLOR support for having colours or not in CLI output
- Fix `robots.txt`template not being used
- RSS feed now takes all available articles by default instead of limiting to 10000
- `templates` directory is now optional
2018-10-15 09:56:03 +00:00
- Add Reason and F# syntax highlighting
- Add `ancestors` to pages and sections pointing to the relative path of all ancestor
sections up to the index to be used with the `get_section` Tera function
2018-10-18 15:33:43 +00:00
- Add a `load_data` Tera function to load local CSV/TOML/JSON files
- Add `relative_path` to pages and sections in templates
- Do not have a trailing slash for the RSS permalinks
- `serve` will now try to find other ports than 1111 rather than panicking
2018-10-22 20:34:38 +00:00
- Ensure content directory exists before rendering aliases
2018-10-23 11:37:23 +00:00
- Do not include drafts in pagination
2018-10-25 14:22:00 +00:00
- Pages filenames starting by a date will now use that date as page date if there isn't one defined in frontmatter
- Accept markdown files starting with BOM
2018-11-03 13:11:38 +00:00
- Add a `watch-only` flag to the `serve` command for when you don't want a webserver
- Add `transparent` sections, for when you want to separate content by sections but want to group them at a higher level (think a `posts` folder with years
that want to use pagination on the index).
- Add `page_template` to section front-matter for when you want to specify the template to use for every page under it
2018-11-10 21:24:27 +00:00
- Improves to `zola serve`: now handles directories renaming
2018-09-05 15:26:39 +00:00
2018-09-03 17:41:30 +00:00
## 0.4.2 (2018-09-03)
- Add assets to section indexes
- Allow users to add custom highlighting syntaxes
- Add Swift, MiniZinc syntaxes and update others
2018-08-25 09:21:02 +00:00
- Handle post summaries better: no more cutting references
2018-08-06 17:40:59 +00:00
## 0.4.1 (2018-08-06)
2018-08-05 08:29:53 +00:00
2018-08-06 17:40:59 +00:00
- Fix live reload of a section content change getting no pages data
2018-08-05 13:03:12 +00:00
- Fix critical bug in `serve` in some OSes
2018-08-06 07:20:54 +00:00
- Update deps, should now build and work correctly on BSDs
2018-08-05 08:29:53 +00:00
2018-08-06 17:40:59 +00:00
## 0.4.0 (2018-08-04)
2018-07-16 08:54:05 +00:00
### Breaking
- Taxonomies have been rewritten from scratch to allow custom ones with RSS and pagination
2018-07-31 13:31:36 +00:00
- `order` sorting has been removed in favour of only having `weight`
2018-08-03 17:47:39 +00:00
- `page.next/page.previous` have been renamed to `page.later/page.earlier` and `page.heavier/page.lighter` depending on the sort method
2018-07-16 08:54:05 +00:00
### Others
- Fix `serve` not working with the config flag
2018-05-11 11:54:16 +00:00
- Websocket port on `live` will not get the first available port instead of a fixed one
2018-05-17 17:04:42 +00:00
- Rewrite markdown rendering to fix all known issues with shortcodes
- Add array arguments to shortcodes and allow single-quote/backtick strings
- Co-located assets are now permalinks
- Words are now counted using unicode rather than whitespaces
2018-05-17 17:08:56 +00:00
- Aliases can now be pointing directly to specific HTML files
- Add `year`, `month` and `day` variables to pages with a date
2018-06-20 15:43:24 +00:00
- Fix panic when live reloading a change on a file without extensions
2018-06-25 17:13:21 +00:00
- Add image resizing support
- Add a 404 template
- Enable preserve-order feature of Tera
- Add an external link checker
- Add `get_taxonomy` global function to return the full taxonomy
2018-06-22 11:33:17 +00:00
## 0.3.4 (2018-06-22)
2018-06-22 11:33:17 +00:00
- `cargo update` as some dependencies didn't compile with current Rust version
- Add CMake syntax highlighting and update other syntax highlighting
2018-03-29 13:30:30 +00:00
## 0.3.3 (2018-03-29)
2018-03-16 18:11:08 +00:00
- Fixed config flag in CLI
- Sitemap entries are now sorted by permalinks to avoid random ordering
- Preserve directory structure from sass folder when copying compiled css files
to the public directory
- Do not require themes to have a static folder
2018-03-19 17:50:04 +00:00
- Now supports indented Sass syntax
2018-03-21 15:18:24 +00:00
- Add search index building
- Update Tera: now has `break` and `continue` in loops
- Gutenberg now creates an anchor link at the position of the `<!-- more -->` tag if you
want to link directly to it
- Fix many shortcode parsing issues
- Correctly copy themes shortcodes so they are useable in content
- Fix internal links not working for markdown files directly in `content` directory
2018-03-16 18:11:08 +00:00
2018-03-05 18:26:21 +00:00
## 0.3.2 (2018-03-05)
- Fix `serve` command trying to read all files as markdown
- Add many syntax highlighting themes
- Fix date being serialised incorrectly in page `extra` section of front-matter
2018-02-15 09:41:49 +00:00
## 0.3.1 (2018-02-15)
2018-01-25 18:12:17 +00:00
2018-02-02 16:34:24 +00:00
- Update Tera and other dependencies
2018-02-15 09:41:49 +00:00
- Add option for inline (ie no `<p>...</p>` wrapping) in markdown filter
2018-02-02 16:34:24 +00:00
- Allow to specify both interface and base_url in `gutenberg serve` for usage in Docker
2018-01-25 18:12:17 +00:00
2018-01-25 14:15:59 +00:00
## 0.3.0 (2018-01-25)
2018-01-02 19:11:19 +00:00
### Breaking
- Change names of individual taxonomies to be plural (ie `tags/my-tag` instead of `tag/my-tag`)
- Front matter now uses TOML dates rather strings: remove quotes from your date value to fix it.
For example: `date = "2001-10-10"` becomes `date = 2001-10-10`
2018-01-16 12:57:31 +00:00
- `language_code` has been renamed `default_language` in preparations of i18n support
2018-01-02 19:11:19 +00:00
### Others
- Add `get_taxonomy_url` to retrieve the permalink of a tag/category
- Fix bug when generating permalinks for taxonomies
2017-11-27 17:09:09 +00:00
- Update to Tera 0.11
- Better UX on first `serve` thanks to some default templates.
2017-12-29 18:33:04 +00:00
- Add `output-dir` to `build` and `serve` to generate the site in a folder other than `public`
2018-01-02 19:11:19 +00:00
- Add Prolog syntax highlighting and update all current syntaxes
2018-01-09 20:57:29 +00:00
- Live reloading now works on shortcode template changes
2018-01-24 12:21:47 +00:00
- `gutenberg serve` now reloads site on `config.toml` changes: you will need to F5 to see any changes though
2018-01-16 12:57:31 +00:00
- Add a `trans` global function that will get return the translation of the given key for the given lang, defaulting
to `config.default_language` if not given
- `gutenberg serve` cleans after itself and deletes the output directory on CTRL+C
2017-11-01 13:58:03 +00:00
## 0.2.2 (2017-11-01)
2017-10-23 08:49:13 +00:00
- Fix shortcodes without arguments being ignored
- Fix shortcodes with markdown chars (_, *, etc) in name and args being ignored
2017-10-24 18:11:39 +00:00
- Fix subsections of index not being filled without a `_index.md`
- Fix generated index section not found in `get_section` global function
2017-10-24 18:11:39 +00:00
- Fix permalink generation for index page
2017-10-25 07:09:55 +00:00
- Add Nim syntax highlighting
2017-10-25 12:49:54 +00:00
- Allow static folder to be missing
- Fix shortcodes args being only passed as strings
2017-10-31 15:41:31 +00:00
- Add `page.components` and `section.components` that are equivalent to `path.split('/')`
2017-11-01 13:58:03 +00:00
- Expose `page.draft` in the template
2017-10-23 08:49:13 +00:00
2017-10-17 09:44:06 +00:00
## 0.2.1 (2017-10-17)
2017-10-16 20:48:59 +00:00
2017-10-17 07:23:17 +00:00
- Fix `base-url` argument to `gutenberg build` being called `base`
- Add syntaxes: Crystal, Elixir, Kotlin
2017-10-16 20:48:59 +00:00
2017-10-05 10:26:29 +00:00
## 0.2.0 (2017-10-05)
2017-09-25 09:55:43 +00:00
- Fix `section.subsections` not being filled correctly
2017-09-26 08:04:18 +00:00
- `section.subsections` can now be sorted by a `weight` attribute on a section front-matter
2017-09-25 09:55:43 +00:00
- Do nothing on directory adding/removal in livereload
- Add back `draft` on pages that was wrongly removed
2017-09-26 08:25:55 +00:00
- Page and Section `path` field is not starting with a `/` anymore
- All Tera global fns are now rebuilt on changes
- Use flags for port/interface in `gutenberg serve`
2017-09-27 14:09:13 +00:00
- Fix various issues with headers markdown rendering
- Rename `insert_anchor` in section front-matter to `insert_anchor_links`
- Remove `insert_anchor_links` from the config: it wasn't used
- Add `class` variable to `gist` shortcode
- Add reading analytics to sections content
2017-10-01 03:51:43 +00:00
- Add config to sitemap template
- Add `permalink` to all taxonomy items (tags & categories)
- Tags in the tags page are now sorting alphabetically instead of by number of pages in them
2017-10-03 15:21:18 +00:00
- Remove deprecated `link` param of `get_url`
- Add 1337 color scheme
- Defaults to compressed Sass output
2017-10-04 00:23:25 +00:00
- Fix regression wrt co-located assets slug detecting
2017-10-04 00:35:37 +00:00
- Rename `url` from page front-matter to `path` to be consistent
- Add a `base-url` flag to the `build` command to override the URL from config.toml
2017-09-25 09:55:43 +00:00
2017-08-31 09:51:18 +00:00
## 0.1.3 (2017-08-31)
- Add themes support
2017-08-10 02:30:19 +00:00
## 0.1.2 (2017-08-10)
- Add `redirect_to` to section front matter to redirect when landing on section
root page
2017-07-27 09:24:43 +00:00
- Make `title` in config optional
- Improved `gutenberg init` UX and users first experience
- Make `get_url` work for any path with optional cachebusting.
2017-08-09 04:42:27 +00:00
- Deprecates `link` param of `get_url` in favour of `path` to be consistent
2017-07-16 02:46:43 +00:00
## 0.1.1 (2017-07-16)
2017-07-15 03:51:32 +00:00
- Fix RSS feed not behaving (https://github.com/Keats/gutenberg/issues/101)
## 0.1.0 (2017-07-14)
2017-06-22 03:01:45 +00:00
- Parallelize all the things
2017-06-29 15:10:24 +00:00
- Add weight sorting
2017-06-29 12:14:08 +00:00
- Remove `section` from the `page` rendering context: this is too expensive. Use
the global function `get_section` if you need to get it
- Put back a 20 page limit on rss feed by default (configurable)
- Remove index page getting all sections: use the `get_section` global fn instead to
only get the ones you need
- Remove pages from pagers in pagination: they were not supposed to be there
2017-07-14 10:26:27 +00:00
- Add built-in Sass compilation support
2017-07-06 13:19:15 +00:00
2017-06-19 09:44:31 +00:00
## 0.0.7 (2017-06-19)
2017-05-30 10:23:07 +00:00
- Sort individual tag/category pages by date
- Add extra builtin shortcode for Streamable videos
- `path` and `permalink` now end with a `/`
2017-06-16 05:05:14 +00:00
- Generate table of contents for each page
- Add `section` to a page Tera context if there is one
2017-06-16 14:09:01 +00:00
- Add `aliases` to pages for when you are changing urls but want to redirect
to the new one
2017-06-19 09:14:13 +00:00
- Name the homepage section `index` (previously empty string)
2017-05-30 10:23:07 +00:00
2017-05-24 12:28:33 +00:00
## 0.0.6 (2017-05-24)
2017-05-16 04:37:00 +00:00
- Fix missing serialized data for sections
- Change the single item template context for categories/tags
2017-05-23 11:03:25 +00:00
- Add a `get_url` and a `get_section` global Tera function
- Add a config option to control how many articles to show in RSS feed
2017-05-23 11:03:25 +00:00
- Move `insert_anchor_links` from config to being a section option and it can
now be insert left or right
2017-05-16 04:37:00 +00:00
2017-05-15 06:57:42 +00:00
## 0.0.5 (2017-05-15)
2017-04-28 07:18:18 +00:00
- Fix XML templates overriding and reloading
- `title` and `description` are now optional in the front matter
- Add GenericConfig, Vim, Jinja2 syntax
2017-05-08 10:29:37 +00:00
- Add `_index.md` for homepage as well and make that into a normal section
- Allow sorting by `none`, `date` and `order` for sections
2017-05-03 12:30:17 +00:00
- Add pagination
2017-05-11 05:12:02 +00:00
- Add a `get_page` global function to tera
- Revamp index page, no more `pages` variables
- Fix livereload stopping randomly
- Smarter re-rendering in `serve` command
2017-04-28 07:18:18 +00:00
2017-04-23 06:32:08 +00:00
## 0.0.4 (2017-04-23)
2017-04-28 07:18:18 +00:00
2017-04-06 02:21:37 +00:00
- Fix RSS feed link and description
- Renamed `Page::url` and `Section::url` to `Page::path` and `Section::path`
- Pass `current_url` and `current_path` to every template
2017-04-10 11:26:35 +00:00
- Add id to headers to allow anchor linking
- Make relative link work with anchors
- Add option to render an anchor link automatically next to headers
- Only copy the static files that changed, not the whole directory in `gutenberg serve`
- Use summary if available in RSS feed
- Add tables and footnotes support in markdown
- Add more language syntaxes
- Only load templates ending by `.html`
2017-04-06 02:21:37 +00:00
## 0.0.3 (2017-04-05)
2017-04-28 07:18:18 +00:00
2017-03-27 02:48:01 +00:00
- Add some colours in console
- Allow using a file other than config.toml for config
- Add sections to the index page context
2017-03-27 14:17:33 +00:00
- Fix page rendering not working when containing `+++`
- Add shortcodes (see README for details)
- Allow relative links to other content in markdown links
2017-04-04 07:08:40 +00:00
- Add `markdown`, `base64_encode` and `base64_decode` filters to the Tera instance of Gutenberg
2017-04-05 12:51:18 +00:00
- Work on Windows!