docs: refactored installation to become quickstart guide

showdownjs / showdown

A bidirectional Markdown to HTML to Markdown converter written in Javascript

http://www.showdownjs.com/

MIT License

14.26k stars 1.56k forks source link

docs: refactored installation to become quickstart guide #900

Closed bandantonio closed 2 years ago

bandantonio commented 2 years ago

During the systematic decomposition of the README file, it was found that the Quick Example part is too short to keep it separate, so I decided to combine it with the Installation to make it more straightforward and complete.

The most interesting parts:

installation tabs

usage tabs (what you write is one click away from what you get)

codeclimate[bot] commented 2 years ago

Code Climate has analyzed commit 314808aa and detected 0 issues on this pull request.

View more on Code Climate.

tivie commented 2 years ago

nice work