Skip to content

Commit

Permalink
docs: polish release notes.
Browse files Browse the repository at this point in the history
docs: fix broken links and update contributors-cli

Closes #672
docs: repair site metadata generation.
docs: do not run site build every time docs update
I have left the links to some external websites that I could not
access, since I do not know whether they're gone for good or
just experiencing some issues.

docs: Update version number in website footer

docs: update changelog page on website

docs: update installation instructions.

Fix #1056.

docs: add missing bracket in config example

chore: update meta dependencies
  • Loading branch information
ludofischer committed May 4, 2021
1 parent 2801e22 commit be7d06f
Show file tree
Hide file tree
Showing 21 changed files with 976 additions and 930 deletions.
16 changes: 8 additions & 8 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"login": "pgilad",
"name": "Gilad Peleg",
"avatar_url": "https://avatars.githubusercontent.com/u/4533329?v=3",
"profile": "http://www.giladpeleg.com/",
"profile": "https://www.giladpeleg.com/",
"contributions": [
"code"
]
Expand Down Expand Up @@ -133,7 +133,7 @@
"login": "yisibl",
"name": "一丝",
"avatar_url": "https://avatars.githubusercontent.com/u/2784308?v=3",
"profile": "www.iyunlu.com/view",
"profile": "https://www.iyunlu.com/view",
"contributions": [
"code",
"test"
Expand Down Expand Up @@ -192,7 +192,7 @@
"login": "jxom",
"name": "Jake Moxey",
"avatar_url": "https://avatars.githubusercontent.com/u/7336481?v=3",
"profile": "jakemoxey.com",
"profile": "https://jakemoxey.com",
"contributions": [
"code"
]
Expand Down Expand Up @@ -281,7 +281,7 @@
"login": "duncanbeevers",
"name": "Duncan Beevers",
"avatar_url": "https://avatars.githubusercontent.com/u/7367?v=3",
"profile": "http://www.duncanbeevers.com",
"profile": "https://www.duncanbeevers.com",
"contributions": [
"code",
"test"
Expand Down Expand Up @@ -376,7 +376,7 @@
"login": "marek-saji",
"name": "Marek ‘saji’ Augustynowicz",
"avatar_url": "https://avatars.githubusercontent.com/u/192323?v=3",
"profile": "http://twitter.com/saji_",
"profile": "https://twitter.com/saji_",
"contributions": [
"code",
"test"
Expand All @@ -386,7 +386,7 @@
"login": "jgerigmeyer",
"name": "Jonny Gerig Meyer",
"avatar_url": "https://avatars.githubusercontent.com/u/552316?v=3",
"profile": "www.oddbird.net",
"profile": "https://www.oddbird.net",
"contributions": [
"code",
"test"
Expand All @@ -406,7 +406,7 @@
"login": "callmevlad",
"name": "Vlad Magdalin",
"avatar_url": "https://avatars.githubusercontent.com/u/785166?v=3",
"profile": "www.webflow.com",
"profile": "https://www.webflow.com",
"contributions": [
"doc"
]
Expand Down Expand Up @@ -616,7 +616,7 @@
"login": "ludofischer",
"name": "Ludovico Fischer",
"avatar_url": "https://avatars1.githubusercontent.com/u/43557?v=4",
"profile": "http://www.ludofischer.com",
"profile": "https://www.ludofischer.com",
"contributions": [
"maintenance"
]
Expand Down
1 change: 1 addition & 0 deletions .remarkrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,5 @@ exports.plugins = [
[require('remark-heading-gap'), {}],
[require('remark-bookmarks'), { bookmarks }],
[require('remark-frontmatter')],
[require('remark-gfm')],
];
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ To help us generate the changelog, follow the [conventional commits](https://www
### Documentation

The documentation website is also included with the repository, under `/site`.
It runs [phenomic](https://phenomic.io) and requires a separate `yarn install`
It runs [docusaurus](https://docusaurus.io) and requires a separate `yarn install`
to pull down the dependencies. You can then browse the documentation locally
by running `yarn start`.

Expand Down Expand Up @@ -126,7 +126,7 @@ If you don't have time to contribute to the project directly, you can also
help us out by starring the repository, or [follow us on Twitter][twitter].
Word of mouth really does mean a lot to us!

You can also [help support us financially](/support-us/).
You can also [help support us financially](/docs/support-us/).


[chat]: https://gitter.im/postcss/postcss
Expand Down
100 changes: 89 additions & 11 deletions CONTRIBUTORS.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ gradient parameters for a smaller output value! In addition, where it's made
sense for a transform, we've added [Browserslist](https://github.com/ai/browserslist)
to provide different output depending on the browsers that you support.

For further details check out the [website](http://cssnano.co/):
For further details check out the [website](https://cssnano.co/):

- [Installation guide for your build process](http://cssnano.co/docs/getting-started).
- [Full list of optimisations](http://cssnano.co/docs/optimisations/).
- [Installation guide for your build process](https://cssnano.co/docs/getting-started).
- [Full list of optimisations](https://cssnano.co/docs/optimisations/).

You can now [try cssnano online](https://cssnano.co/playground/)!

Expand Down Expand Up @@ -68,4 +68,4 @@ Support this project by becoming a sponsor. Your logo will show up here with a l

## License

MIT © [Ben Briggs](http://beneb.info)
MIT © [Ben Briggs](https://beneb.info)
29 changes: 15 additions & 14 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"postinstall": "lerna bootstrap",
"build:packages": "babel-node ./util/buildPackages.js",
"build:metadata": "babel-node ./util/buildMetadata.js",
"build:site": "remark site/docs/**/*.md -o && yarn build:metadata && babel-node ./util/buildSiteMarkdown.js && cd site && yarn build",
"build:docs": "remark site/docs/**/*.md -o && yarn build:metadata && babel-node ./util/buildSiteMarkdown.js",
"build:integration": "cross-env BABEL_ENV=test babel-node ./util/buildFrameworks.js",
"pretest": "yarn lint",
"test:only": "cross-env BABEL_ENV=test jest",
Expand All @@ -25,12 +25,12 @@
"@babel/core": "^7.14.0",
"@babel/node": "^7.13.13",
"@babel/preset-env": "^7.14.0",
"all-contributors-cli": "^5.11.0",
"all-contributors-cli": "^6.20.0",
"babel-eslint": "^10.0.1",
"babel-jest": "^26.6.3",
"babel-plugin-add-module-exports": "^1.0.2",
"browserslist": "^4.16.0",
"camelcase": "^5.3.1",
"camelcase": "^6.2.0",
"chalk": "^4.1.0",
"cross-env": "^7.0.3",
"css-color-names": "^1.0.1",
Expand All @@ -43,7 +43,7 @@
"eslint-plugin-react": "^7.21.4",
"fs-extra": "^8.0.1",
"get-pkg-repo": "^4.1.0",
"gh-pages": "^1.2.0",
"gh-pages": "^3.1.0",
"glob": "^7.1.4",
"got": "^11.8.1",
"html2plaintext": "^2.1.2",
Expand All @@ -59,21 +59,22 @@
"postcss-simple-vars": "^6.0.1",
"postcss-value-parser": "^4.1.0",
"prettier": "^2.2.1",
"remark": "^10.0.1",
"remark": "^13.0.0",
"remark-behead": "^2.2.1",
"remark-bookmarks": "^2.1.0",
"remark-cli": "^6.0.1",
"remark-frontmatter": "^1.3.1",
"remark-github": "^7.0.6",
"remark-heading-gap": "^3.1.0",
"remark-html": "^9.0.0",
"remark-bookmarks": "^3.0.0",
"remark-cli": "^9.0.0",
"remark-frontmatter": "^3.0.0",
"remark-gfm": "^1.0.0",
"remark-github": "^10.0.1",
"remark-heading-gap": "^4.0.0",
"remark-html": "^13.0.1",
"remark-license": "^5.0.1",
"remark-toc": "^5.1.1",
"remark-toc": "^7.2.0",
"stringify-object": "^3.3.0",
"toml": "^3.0.0",
"tomlify-j0.4": "^3.0.0",
"unist-builder": "^1.0.4",
"unist-util-remove": "^1.0.2",
"unist-builder": "^2.0.3",
"unist-util-remove": "^2.1.0",
"write-file": "^1.0.0"
},
"browserslist": {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,23 +1,28 @@
---
slug: cssnano-5-release-notes
title: cssnano 5 release
title: cssnano 5 is available
author: Ludovico Fischer
---

We have released a new version of cssnano.
We have released a new major version of cssnano.

## Major changes
## Major changes in cssnano 5

* requires Node >= 10.13
* cssnano 5 requires Node.js >= 10.13
* PostCSS 8 API, so cssnano 5 does not emit warnings when running under PostCSS 8
* updated to SVGO 2, fixing many SVG minification bugs
* updated css-value-parser and css-selector-parser, fixing many bugs
* updates to SVGO 2, fixing many SVG minification bugs
* updates css-value-parser and css-selector-parser, fixing many bugs

### Upgrade notes
If you use the cssnano JavaScript API, you need to change your code:
## How to Upgrade
### Update the PostCSS dependency
Add `postcss` to your `package.json` `dependencies` field, if your package manager does not install peer dependencies automatically.

* Replace `cssnano.process()` with `cssnano().process()` (notice the `()` after `cssnano`)
### JavaScript API changes
If you use the cssnano JavaScript API, change your code:

* cssnano specific options go into the options go to cssnano instead of process
* replace `cssnano.process()` with `cssnano().process()` (notice the `()` after `cssnano`)

* pass cssnano options to `cssnano()` instead of `process()`

```
cssnano(cssnanoOptions).process(postcssOptions)
Expand Down
112 changes: 106 additions & 6 deletions site/docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,106 @@ layout: Page
<!-- This file was automatically generated. -->


## Change Log

All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

### [5.0.2](https://github.com/cssnano/cssnano/compare/cssnano@5.0.0...cssnano@5.0.2) (2021-04-26)

#### Bug Fixes

- **cssnano:** replace opencollective with funding field. ([#1047](https://github.com/cssnano/cssnano/issues/1047)) ([3dee7c5](https://github.com/cssnano/cssnano/commit/3dee7c553350e43ad0750a9478a63cf897e5510f)), closes [#1046](https://github.com/cssnano/cssnano/issues/1046)

### [5.0.1](https://github.com/cssnano/cssnano/compare/cssnano@5.0.0...cssnano@5.0.1) (2021-04-13)

#### Bug Fixes

- **cssnano:** replace opencollective with funding field. ([#1047](https://github.com/cssnano/cssnano/issues/1047)) ([3dee7c5](https://github.com/cssnano/cssnano/commit/3dee7c553350e43ad0750a9478a63cf897e5510f)), closes [#1046](https://github.com/cssnano/cssnano/issues/1046)


## [5.0.0](https://github.com/cssnano/cssnano/compare/cssnano@5.0.0-rc.2...cssnano@5.0.0) (2021-04-06)

**Note:** Version bump only for package cssnano


## [5.0.0-rc.2](https://github.com/cssnano/cssnano/compare/cssnano@5.0.0-rc.1...cssnano@5.0.0-rc.2) (2021-03-15)

#### Bug Fixes

- update SVGO ([aa07cfd](https://github.com/cssnano/cssnano/commit/aa07cfd62c82ed4b1e87219eea8d0ed99635e4ca))


## [5.0.0-rc.1](https://github.com/cssnano/cssnano/compare/cssnano@5.0.0-rc.0...cssnano@5.0.0-rc.1) (2021-03-04)

**Note:** Version bump only for package cssnano


## 5.0.0-rc.0 (2021-02-19)

#### Bug Fixes

- **postcss-ordered-values:** columns transform returning string instead of the AST ([#928](https://github.com/cssnano/cssnano/issues/928)) ([a5d6d36](https://github.com/cssnano/cssnano/commit/a5d6d364e0815ecb198a95de301f3554ccce4f78))
- **unique-selector:** removed sorting and involving selector comments ([#857](https://github.com/cssnano/cssnano/issues/857)) ([3fa875d](https://github.com/cssnano/cssnano/commit/3fa875dade2138e1a531dce1f8b79814cb39dbc9))

#### chore

- minimum require version of node is 10.13 ([#871](https://github.com/cssnano/cssnano/issues/871)) ([28bda24](https://github.com/cssnano/cssnano/commit/28bda243e32ce3ba89b3c358a5f78727b3732f11))

#### Features

- css declaration sorter ([#855](https://github.com/cssnano/cssnano/issues/855)) ([613d562](https://github.com/cssnano/cssnano/commit/613d562ae79e7e169c80b523b7c2c9b0093bc1d8))
- migarete to PostCSS 8 ([#975](https://github.com/cssnano/cssnano/issues/975)) ([40b82dc](https://github.com/cssnano/cssnano/commit/40b82dca7f53ac02cd4fe62846dec79b898ccb49))
- **postcss-reduce-transforms:** improve optimizations ([#745](https://github.com/cssnano/cssnano/issues/745)) ([b0f0d89](https://github.com/cssnano/cssnano/commit/b0f0d892316d7b77e8033a6dc8d67745043a5072))

#### BREAKING CHANGES

- minimum supported `postcss` version is `8.2.1`
- minimum require version of node is 10.13

### 4.1.10 (2019-02-14)

### 4.1.9 (2019-02-12)

#### Bug Fixes

- initial loading time ([#654](https://github.com/cssnano/cssnano/issues/654)) ([de2ef07](https://github.com/cssnano/cssnano/commit/de2ef074a0c7da94c22a5b0336e6c4ca2a94f1b5))

### 4.1.7 (2018-10-22)

### 4.1.6 (2018-10-22)

### 4.1.5 (2018-10-17)

#### Bug Fixes

- toggling of plugins in presets using boolean configuration option ([#622](https://github.com/cssnano/cssnano/issues/622)) ([15076f1](https://github.com/cssnano/cssnano/commit/15076f145118507e010722cc9ed548ffe1b91f8c))

### 4.1.4 (2018-09-27)

### 4.1.3 (2018-09-25)

### 4.1.2 (2018-09-25)

### 4.1.1 (2018-09-24)

#### Bug Fixes

- parse error with iPhone X feature ([#614](https://github.com/cssnano/cssnano/issues/614)) ([a3704a7](https://github.com/cssnano/cssnano/commit/a3704a76a631b1cd907ab0c0a8637a622769676d))


## 4.1.0 (2018-08-24)

### 4.0.5 (2018-07-30)

### 4.0.4 (2018-07-25)

### 4.0.3 (2018-07-18)

#### Bug Fixes

- **postcss-merge-longhand:** not mangle border output ([#555](https://github.com/cssnano/cssnano/issues/555)) ([9a70605](https://github.com/cssnano/cssnano/commit/9a706050b621e7795a9bf74eb7110b5c81804ffe)), closes [#553](https://github.com/cssnano/cssnano/issues/553) [#554](https://github.com/cssnano/cssnano/issues/554)


## 4.1.10

Expand All @@ -23,7 +123,7 @@ layout: Page
- `postcss-merge-rules` increase performance
- `postcss-minify-params` increase performance
- `postcss-minify-selectors`: increase performance
- `postcss-normalize-display-values`: increase performance
- `postcss-normalize-display-values`: increase performance
- `postcss-normalize-positions`: increase performance
- `postcss-normalize-repeat-style`: increase performance
- `postcss-normalize-string`: increase performance
Expand Down Expand Up @@ -189,7 +289,7 @@ layout: Page

### Bug Fixes

- postcss-normalize-unicode doesn't change `U` to lowercase for `IE` &lt;= 11 and `Edge` &lt;= 15.
- postcss-normalize-unicode doesn't change `U` to lowercase for `IE` <= 11 and `Edge` <= 15.
- postcss-merge-longhand works with custom properties (Example `a { border-style:dotted; border-style:var(--variable) }`) correctly.
- postcss-ordered-values handle `border` property with invalid border width value correctly.
- postcss-merge-rules handles `:-ms-input-placeholder` and `::-ms-input-placeholder` selectors correctly.
Expand Down Expand Up @@ -282,7 +382,7 @@ the actual release.
- `postcss-reduce-idents`
- `postcss-zindex`

Note that you can load `cssnano-preset-advanced` instead which _does_ contain
Note that you can load `cssnano-preset-advanced` instead which *does* contain
these transforms.

- We no longer detect previous plugins to silently exclude our own, and now
Expand Down Expand Up @@ -372,7 +472,7 @@ the actual release.
## 3.7.7

- Further improves CSS mixin handling; semicolons will no longer be stripped
from _rules_ as well as declarations.
from *rules* as well as declarations.


## 3.7.6
Expand Down Expand Up @@ -417,7 +517,7 @@ the actual release.
- Added: Reduce `background-repeat` definitions; works with both this property
& the `background` shorthand, and aims to compress the extended two value
syntax into the single value syntax.
- Added: Reduce `initial` values for properties when the _actual_ initial value
- Added: Reduce `initial` values for properties when the *actual* initial value
is shorter; for example, `min-width: initial` becomes `min-width: 0`.


Expand Down Expand Up @@ -493,7 +593,7 @@ the actual release.

- cssnano no longer converts `outline: none` to `outline: 0`, as there are
some cases where the values are not equivalent (thanks to [**@TrySound**](https://github.com/TrySound)).
- cssnano no longer converts for example `16px` to `1pc` _by default_. Length
- cssnano no longer converts for example `16px` to `1pc` *by default*. Length
optimisations can be turned on via `{convertValues: {length: true}}`.
- Improved minimization of css functions (thanks to [**@TrySound**](https://github.com/TrySound)).

Expand Down

0 comments on commit be7d06f

Please sign in to comment.