Releases: peopledoc/styledown
v5.0.0
Breaking changes
- Drop node 10 support (#162)
Chores
- Refine information in
package.json+ add LICENSE file by @MrChocolatine in #149 - Add CODEOWNERS file by @MrChocolatine in #155
CI
- New workflow to auto-update list of contributors by @MrChocolatine in #150
- Auto-update list of contributors by @github-actions in #153
Docs
- Rename filename
ReadmetoREADMEby @MrChocolatine in #151 - Update README documentation by @GreatWizard in #152
- Fix README by @GreatWizard in #154
Dependabot
- build(deps-dev): bump eslint from 7.26.0 to 7.27.0 by @dependabot in #126
- build(deps-dev): bump sinon from 10.0.0 to 11.1.0 by @dependabot in #127
- build(deps): bump marked from 2.0.5 to 2.0.6 by @dependabot in #128
- build(deps-dev): bump sinon from 11.1.0 to 11.1.1 by @dependabot in #129
- build(deps): bump marked from 2.0.6 to 2.0.7 by @dependabot in #130
- build(deps): bump glob-parent from 5.1.1 to 5.1.2 by @dependabot in #132
- build(deps-dev): bump eslint from 7.27.0 to 7.28.0 by @dependabot in #133
- build(deps-dev): bump mocha from 8.4.0 to 9.0.3 by @dependabot in #138
- build(deps): bump prettier from 2.3.0 to 2.3.2 by @dependabot in #140
- build(deps): bump marked from 2.0.7 to 2.1.3 by @dependabot in #141
- build(deps-dev): bump eslint from 7.28.0 to 7.32.0 by @dependabot in #142
- build(deps-dev): bump sinon from 11.1.1 to 11.1.2 by @dependabot in #143
- build(deps): bump path-parse from 1.0.6 to 1.0.7 by @dependabot in #145
- build(deps): bump js-beautify from 1.13.13 to 1.14.0 by @dependabot in #144
- build(deps): bump highlight.js from 10.7.2 to 11.3.1 by @dependabot in #147
- build(deps-dev): bump sinon from 11.1.2 to 12.0.1 by @dependabot in #156
- build(deps-dev): bump mocha from 9.0.3 to 9.1.3 by @dependabot in #159
- build(deps): bump prettier from 2.3.2 to 2.5.1 by @dependabot in #160
- build(deps-dev): bump eslint-config-peopledoc from 2.0.2 to 3.0.2 by @dependabot in #146
- build(deps): bump marked from 2.1.3 to 4.0.6 by @dependabot in #162
- build(deps-dev): bump eslint from 7.32.0 to 8.4.1 by @dependabot in #161
- build(deps): bump marked from 4.0.6 to 4.0.7 by @dependabot in #163
- build(deps): remove unused js-beautify dependency by @ryuran in #164
New Contributors
- @GreatWizard made their first contribution in #152
- @github-actions made their first contribution in #153
Full Changelog: v4.1.0...v5.0.0
Contributors
Assets 2
v4.1.0
Update dependencies
Changelog from v4.0.0 to v4.1.0:
v4.0.0...v4.1.0
v4.0.0
v3.0.2
Release 3.0.2
v3.0.1
Merge pull request #67 from peopledoc/release/3.0.1 Release 3.0.1
v3.0.0
Breaking change
Deploy on Github registry (#63)
Ref(s): JS-423
styledown is now deployed on Github registry under @peopledoc/ scope.
Change all the import from styledown to @peopledoc/styledown.
Feat
Beautify HTML output using prettier
Currently, the HTML generated for the code sample using PUG is not very readable.
Here's what it looks like for a button group.
This is because PUG has been designed to generate HTML that works and that's all (they have no intention an adding a beautify feature).
In a documentation code samples should be as readable as possible to help the reader. There's already a beautifier included (https://beautifier.io/) but for some reason, it's not working correctly. This is why we've decided to replace it with prettier which works and can make the code sample more readable.
Here's the same example as before but beautified with prettier.
Limit code sample boxes width
Styledown CSS has been updated to limit the width of the code boxes to 500px max. This is to prevent them from taking to much space on documentation pages
Build
Use Github actions as CI instead of CircleCI
v2.1.0
Feat
Beautify HTML output using prettier
Currently, the HTML generated for the code sample using PUG is not very readable.
Here's what it looks like for a button group.
This is because PUG has been designed to generate HTML that works and that's all (they have no intention an adding a beautify feature).
In a documentation code samples should be as readable as possible to help the reader. There's already a beautifier included (https://beautifier.io/) but for some reason, it's not working correctly. This is why we've decided to replace it with prettier which works and can make the code sample more readable.
Here's the same example as before but beautified with prettier.
Limit code sample boxes width
Styledown CSS has been updated to limit the width of the code boxes to 500px max. This is to prevent them from taking to much space on documentation pages
v2.0.2
Fix set Pug to generate valid HTML
v2.0.0
Breaking change ⚠️
- It's no longer possible to use Styledown after a pipe
|. (#22) - Styledown build for browsers is no longer available. (#20)
- Styledown.js has drop support for ie<9. (#21)
Feature 🚀
- Calling Styledown command alone will now display the help message. (#22)
- It's now possible to use Pug include statement to include external templates at build time. (#19)