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