diff options
author | Frieder Griesshammer <frieder.griesshammer@der-beweis.de> | 2021-09-14 20:02:28 +0300 |
---|---|---|
committer | Frieder Griesshammer <frieder.griesshammer@der-beweis.de> | 2021-09-14 20:02:28 +0300 |
commit | 294dee9697f9eca64551764d3fcc7ee5b78335e7 (patch) | |
tree | b3e0fe0f2c5a5353cfe7ea23468bbddabb576e4d /CHANGELOG.md | |
parent | 673f4bce1358b8253b7ab08655e6e8aabcf28a06 (diff) |
Unify backtick usage inside 'CHANGELOG.md'
Diffstat (limited to 'CHANGELOG.md')
-rw-r--r-- | CHANGELOG.md | 214 |
1 files changed, 108 insertions, 106 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index ff5a770..0075e96 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,10 @@ and this project adheres to - Some `demosite` entry into `theme.toml`. +### Changed + +- Major cleanup of `CHANGELOG.md`: unify backtick usage. + ### Removed - Drop `build-site.js` script as it is unused. @@ -46,15 +50,14 @@ and this project adheres to ### Added -- Added setting ``showMeta`` which allows hiding the title, date and meta info +- Added setting `showMeta` which allows hiding the title, date and meta info of posts in single view. ### Changed - Reformatted all `.md` files so markdown lint should not report any issues. -- Updated ``autoprefixer``, ``cssnano``, ``del-cli``, - ``postcss-discard-comments``, ``rollup``, ``tslib``, ``typescript`` - and inner dependencies. +- Updated `autoprefixer`, `cssnano`, `del-cli`, `postcss-discard-comments`, + `rollup`, `tslib`, `typescript` and inner dependencies. ### Fixed @@ -64,12 +67,12 @@ and this project adheres to ### Changed -- Updated ``autoprefixer``, ``postcss-discard-comments``, ``postcss-import``, - ``postcss-url``, ``purecss``, ``rollup``, - ``tslib``, ``typescript`` and inner dependencies. -- Switched from ``rollup-plugin-typescript2`` to ``@rollup/plugin-typescript``. -- Switched from ``source-sans-pro`` and ``source-serif-pro`` to - ``source-sans`` and ``source-serif`` (got renamed). +- Updated `autoprefixer`, `postcss-discard-comments`, `postcss-import`, + `postcss-url`, `purecss`, `rollup`, `tslib`, `typescript` + and inner dependencies. +- Switched from `rollup-plugin-typescript2` to `@rollup/plugin-typescript`. +- Switched from `source-sans-pro` and `source-serif-pro` to + `source-sans` and `source-serif` (got renamed). ### Fixed @@ -80,10 +83,9 @@ and this project adheres to ### Changed -- Updated ``autoprefixer``, ``postcss``, ``postcss-import``, - ``postcss-import``, ``rollup``, ``rollup-plugin-postcss``, ``typescript``, - ``tslib`` and inner dependencies. -- Changed all paths inside ``rollup.config.js`` to be absolute. This reflects +- Updated `autoprefixer`, `postcss`, `postcss-import`, `rollup`, + `rollup-plugin-postcss`, `typescript`, `tslib` and inner dependencies. +- Changed all paths inside `rollup.config.js` to be absolute. This reflects new API from *postcss* and avoids trouble when building from other contexts. ### Fixed @@ -106,17 +108,17 @@ and this project adheres to ### Changed -- Updated ``purecss``, ``autoprefixer``, ``rollup``, some of it's plugins, - ``typescript`` and inner dependencies. +- Updated `purecss`, `autoprefixer`, `rollup`, some of it's plugins, + `typescript` and inner dependencies. ## [v0.3.1] ### Changed -- Switched typescript plugin from ``rollup-plugin-typescript`` - to ``rollup-plugin-typescript2`` to be better aware of errors. +- Switched typescript plugin from `rollup-plugin-typescript` + to `rollup-plugin-typescript2` to be better aware of errors. - Adjusted typescript module to fit all conventions. -- Updated ``autoprefixer``, ``rollup``, some of it's plugins, ``typescript`` +- Updated `autoprefixer`, `rollup`, some of it's plugins, `typescript` and inner dependencies. - Regular pages (not posts) are omitted on the main index pages. - Dropped compatibility stylesheet for old Internet Explorer versions. @@ -134,28 +136,28 @@ and this project adheres to - Introduced [Hugo Pipes](https://gohugo.io/hugo-pipes/) to include CSS and JavaScript files. This introduces fingerprinting - (Custom stylesheets can now be placed under ``assets`` to + (Custom stylesheets can now be placed under `assets` to fingerprint them as well). -- Enable placement of favicon into ``assets`` folder to enable fingerprinting +- Enable placement of favicon into `assets` folder to enable fingerprinting as well. -- Updated feed template to honor the ``services.rss.limit`` setting. +- Updated feed template to honor the `services.rss.limit` setting. ### Changed -- Updated ``rollup``, ``autoprefixer``, fonts and inner dependencies. +- Updated `rollup`, `autoprefixer`, fonts and inner dependencies. - Use local files for screenshots in *changelog* site. - Reimplemented JavaScript part in typescript for better code quality and compatibility. -- Cleanup the ``build-sites.js`` script using template literals. -- Replaced deprecated ``.Site.RSSLink`` with ``.OutputFormats.Get "RSS"``. -- Changed link building to use ``.RelPermalink`` or ``relUrl`` for proper - ``canonifyURLs`` behavior. -- Updated ``README.md``. +- Cleanup the `build-sites.js` script using template literals. +- Replaced deprecated `.Site.RSSLink` with `.OutputFormats.Get "RSS"`. +- Changed link building to use `.RelPermalink` or `relUrl` for proper + `canonifyURLs` behavior. +- Updated `README.md`. - Added horizontal spacing for all code blocks. ### Fixed -- Prevent adding the ``pure-table`` CSS class to tables containing +- Prevent adding the `pure-table` CSS class to tables containing code listings. This fixes broken display of code, and allows better output of line numbers alongside code samples. - Generate feed from the proper input source to find all matching pages. @@ -166,15 +168,15 @@ and this project adheres to ### Added - Created some 404 page. -- Display ``README.md`` file in *changelog* site - rewritten shortcode +- Display `README.md` file in *changelog* site - rewritten shortcode template to support this. ### Changed - Replaced hardcoded text in the 404 page with something freely configurable. -- Updated ``rollup``, ``autoprefixer``, ``del-cli`` and inner dependencies. -- Updated ``purecss`` and ``source-serif-pro`` font. -- Dropped usage of now deprecated Page's ``.Hugo`` and ``.URL`` functions. +- Updated `rollup`, `autoprefixer`, `del-cli` and inner dependencies. +- Updated `purecss` and `source-serif-pro` font. +- Dropped usage of now deprecated Page's `.Hugo` and `.URL` functions. - Rewritten terms listing to use the taxonomy pages - this avoids manual creation of links, allows usage of link titles and outputs proper taxonomy names (instead of only lowercased ones). @@ -192,76 +194,76 @@ and this project adheres to ### Changed -- Moved old exampleSite into ``_sites/example``, using a symlink to keep - (required) ``exampleSite`` intact. -- Updated ``autoprefixer``. -- Let ``build-example.js`` script pass through the exit code of hugo on error. -- Renamed ``build-example.js`` to ``build-site.js``. -- Make ``build-site.js`` evaluate some commandline flag to build any site - below ``_sites``. - Use e.g. ``npm run site -- changelog`` to build *changelog*. +- Moved old exampleSite into `_sites/example`, using a symlink to keep + (required) `exampleSite` intact. +- Updated `autoprefixer`. +- Let `build-example.js` script pass through the exit code of hugo on error. +- Renamed `build-example.js` to `build-site.js`. +- Make `build-site.js` evaluate some commandline flag to build any site + below `_sites`. + Use e.g. `npm run site -- changelog` to build *changelog*. - Dropped right aligning of the subtitle on smaller viewports. - Changed the breakpoint size in the JavaScript to match with the CSS. ### Fixed -- Allow ``build-site.js`` script to be launched from any directory. +- Allow `build-site.js` script to be launched from any directory. - Fix spacing issues for inline code tags and leading indent of code blocks. -- Changed the order how the grid of ``purecss`` is bundled together. +- Changed the order how the grid of `purecss` is bundled together. Fixes issue where the responsive grid elements did not work. ## [v0.2.0] ### Added -- Introduced ``showNavHeader`` setting which allows hiding the top - navigation with title/subtitle if set to ``false``. +- Introduced `showNavHeader` setting which allows hiding the top + navigation with title/subtitle if set to `false`. Tanks [@mattt-b](https://github.com/mattt-b) for the idea & subtle hint. -- Introduced ``showEmptyPagination`` setting which hides the pagination - if there is not enough content to paginate if set to ``false``. +- Introduced `showEmptyPagination` setting which hides the pagination + if there is not enough content to paginate if set to `false`. Tanks [@mattt-b](https://github.com/mattt-b) for the idea & subtle hint. -- Added setting ``showMetaDates`` which allows hiding the date field of posts. +- Added setting `showMetaDates` which allows hiding the date field of posts. - Added build target for dist versions of assets without deleting them first. - This prevents a parallel running ``hugo serve`` from getting confused. -- Added setting ``showMetaLinks`` which allows hiding the meta info of posts. -- Introduced new ``menu.meta`` navigation settings → meta info links for + This prevents a parallel running `hugo serve` from getting confused. +- Added setting `showMetaLinks` which allows hiding the meta info of posts. +- Introduced new `menu.meta` navigation settings → meta info links for posts are now freely configurable: Names and URLs can be changed, Titles may - be set, ordering (``weight``) can be influenced. + be set, ordering (`weight`) can be influenced. Tanks [@mattt-b](https://github.com/mattt-b) for the idea & subtle hint. - Added meta links to taxonomy RSS feeds in the html header. ### Changed -- Option to show full content is now called ``showFullContent`` (camelCase). -- Replaced all ``cond isset ($.Site.Params "foo") $.Site.Params.foo "bar"`` - constructs with ``default "bar" $.Site.Params.foo``. -- Changed all relative URLs inside ``README.md`` so the demo page does +- Option to show full content is now called `showFullContent` (camelCase). +- Replaced all `cond isset ($.Site.Params "foo") $.Site.Params.foo "bar"` + constructs with `default "bar" $.Site.Params.foo`. +- Changed all relative URLs inside `README.md` so the demo page does not have broken links. - Clarified consequences when title is not set in config. -- Set ``preserveTaxonomyNames`` to true for ``exampleSite/config.toml`` +- Set `preserveTaxonomyNames` to true for `exampleSite/config.toml` (allows to spot bugs early from improper taxonomy handling). -- Updated ``autoprefixer`` and ``rollup``. -- Option to format date is now called ``dateFmt`` (camelCase). -- Set fallback date (if ``dateFmt`` not set) to RFC822. -- Renamed ``footer-content`` CSS class to ``footer``. -- Introduced ``navigation`` CSS class wrapping ``navigation-header`` and - ``navigation-content``. +- Updated `autoprefixer` and `rollup`. +- Option to format date is now called `dateFmt` (camelCase). +- Set fallback date (if `dateFmt` not set) to RFC822. +- Renamed `footer-content` CSS class to `footer`. +- Introduced `navigation` CSS class wrapping `navigation-header` and + `navigation-content`. - Display of subtitle will not be right aligned anymore on small viewports. -- Using ``path.Join`` to construct URLs - This is more robust if any part +- Using `path.Join` to construct URLs - This is more robust if any part contains leading or trailing slashes. - Information of meta links for posts is not hardcoded anymore and can be - configured using ``menu.meta`` setting. + configured using `menu.meta` setting. ### Fixed - Cleaned up some minor parts (mostly whitespace and formatting issues). -- Adjusted line below header to relate to the new ``header`` class. +- Adjusted line below header to relate to the new `header` class. - Ensured that an empty navigation does not draw an empty - ``navigation-content`` container. + `navigation-content` container. → This allows a site to be completely without any navigation, only one of both, or all of them. -- Added a ``clearfix`` CSS rule to prevent display issues with sites that only - use a subtitle as ``navigation``. +- Added a `clearfix` CSS rule to prevent display issues with sites that only + use a subtitle as `navigation`. ## [v0.1.5] - 2019-03-02 @@ -271,9 +273,9 @@ and this project adheres to ### Changed -- Using sensible URLs for the ``exampleSite/config.toml`` footer links. +- Using sensible URLs for the `exampleSite/config.toml` footer links. - Unified headline style outside and inside post content. -- Updated ``rollup``. +- Updated `rollup`. ### Fixed @@ -288,7 +290,7 @@ and this project adheres to Thanks [@dtieber](https://github.com/dtieber) for the pull request. - Explicit check if files exist on disk before including them (custom stylesheet, favicon) - This avoids unnecessary 404 requests. -- Introduced this ``CHANGELOG.md`` file. +- Introduced this `CHANGELOG.md` file. ### Fixed @@ -302,14 +304,14 @@ and this project adheres to ### Changed -- Updated ``autoprefixer``, ``postcss-discard-comments``, ``rollup`` - and ``rollup-plugin-postcss``. -- Replaced ``rollup-plugin-copy`` with ``rollup-plugin-copier``. - The former package used deprecated build hooks from ``rollup``. +- Updated `autoprefixer`, `postcss-discard-comments`, `rollup` + and `rollup-plugin-postcss`. +- Replaced `rollup-plugin-copy` with `rollup-plugin-copier`. + The former package used deprecated build hooks from `rollup`. ### Removed -- Dropped ``postcss-advanced-variables`` package from the build toolchain. +- Dropped `postcss-advanced-variables` package from the build toolchain. This allows proper linting of CSS files. ## [v0.1.2] - 2019-01-16 @@ -320,10 +322,10 @@ and this project adheres to ### Changed -- Replaced ``trash-cli`` package with ``del-cli`` for the build toolchain. -- Using recommended url inside the ``exampleSite/config.toml``. -- Updated ``source-sans-pro`` and ``source-serif-pro`` fonts. -- Updated ``autoprefixer`` and ``rollup``. +- Replaced `trash-cli` package with `del-cli` for the build toolchain. +- Using recommended url inside the `exampleSite/config.toml`. +- Updated `source-sans-pro` and `source-serif-pro` fonts. +- Updated `autoprefixer` and `rollup`. ## [v0.1.1] - 2018-12-23 @@ -333,8 +335,8 @@ and this project adheres to ### Fixed -- Some issues/missing parts in the ``exampleSite/config.toml``. -- Placement of images inside ``figure`` tag is now centered on page. +- Some issues/missing parts in the `exampleSite/config.toml`. +- Placement of images inside `figure` tag is now centered on page. - Links to categories, tags and series are now properly generated when the names contain spaces. @@ -342,57 +344,57 @@ and this project adheres to ### Added -- Added ``.editorconfig`` file. -- Started ``packace.json`` file for ``npm``. -- Added ``source-code-pro``, ``source-sans-pro`` and - ``source-serif-pro`` fonts. -- Added ``purecss`` as css framework. -- Implemented a build toolchain using ``rollup``, - ``postcss-import``, ``postcss-url``. +- Added `.editorconfig` file. +- Started `packace.json` file for `npm`. +- Added `source-code-pro`, `source-sans-pro` and + `source-serif-pro` fonts. +- Added `purecss` as css framework. +- Implemented a build toolchain using `rollup`, + `postcss-import`, `postcss-url`. - Added Twitter Cards, Open Graph and Schema.org integration - (using internal ``hugo`` templates). + (using internal `hugo` templates). - Added a fully customizable menu for the footer. - Added RSS Feed with complete entries (Atom format). - Added a fully customizable menu for the header. - Implemented pagination for posts and taxonomies displays. -- Added ``Tomorrow Night`` color scheme for syntax highlighting. -- Extended build toolchain with ``autoprefixer``, - ``postcss-discard-comments``, ``postcss-advanced-variables``. +- Added `Tomorrow Night` color scheme for syntax highlighting. +- Extended build toolchain with `autoprefixer`, + `postcss-discard-comments`, `postcss-advanced-variables`. - Implemented a custom stylesheet using colors from the - ``Tomorrow`` color scheme. -- Added ``build-example.js`` script to build ``exampleSite`` - locally (through ``node``). + `Tomorrow` color scheme. +- Added `build-example.js` script to build `exampleSite` + locally (through `node`). - Extended build toolchain with run commands - (``dev``, ``dist``, ``version``, etc...). + (`dev`, `dist`, `version`, etc...). ### Changed - Unified whitespace inside all templates from the fork. -- Updated entries for ``exampleSite`` to more recent versions. +- Updated entries for `exampleSite` to more recent versions. - Copyright notice in footer sets year automatically. - Merged main and font stylesheets into one. -- Updated ``README.md`` with current information. +- Updated `README.md` with current information. - Improved display of page metadata. - Changed inclusion of templates using blocks instead of partials. -- Reduced css size (including only parts of ``purecss`` which are in use). +- Reduced css size (including only parts of `purecss` which are in use). ### Fixed - Replaced "Back to top" feature with some proper JavaScript implementation. -- Using RFC 3339 time format inside ``<time>`` tags. +- Using RFC 3339 time format inside `<time>` tags. - Unified and simplified the usage of the css grid columns. - Improve behaviour when config entries are missing (by setting/using sane defaults). ### Removed -- Dropped ``custom_head.html`` Template. +- Dropped `custom_head.html` Template. - Dropped Google Analytics feature. - Dropped Google Fonts for enhanced privacy. -- Dropped highlightjs (``hugo`` can do that using ``pygments`` or ``chroma``). +- Dropped highlightjs (`hugo` can do that using `pygments` or `chroma`). - Cleaned many parts with duplicated code. -- Dropped unused ``single.html`` Template. -- Dropped all prebuilt stylesheets (building them with ``rollup`` now). +- Dropped unused `single.html` Template. +- Dropped all prebuilt stylesheets (building them with `rollup` now). ## [Pre-Fork] |