-
Notifications
You must be signed in to change notification settings - Fork 0
Choose framework, library and tools
The Node eco-system is vast with many Library, Tools or Frameworks, which are often do the same things.
- There are defactor library or tools which you will naturally choose to use without asking any question.
- There are competitive Library, Tools or Frameworks with all the pros and cons, and we are struggling to choose the right one in our situation.
In this article, I will describe the way I evole to come with the right tool for the right.
In my case, I need to build a documentation website for my new library. There are many tools in a variety of size and shape, pros and cons: Hugo, Vuepress, Astro, Docsify...
It was a mistake if you try to compare these tools first hands, then go right away to use one. Here how I did thing
- The markdown-format is the defactor for these kind of documentation, no need to discuss about it
- I start to right the documentation on my API right away. I have to write these documentation whatever tool I choose later.
- Maybe users can read the documentation directly on Github (so we don't need any other tool or framework?) => NO I need a sidebar, a search bar, and I want to show multiple codes example in Tabs panels.
- Here come: Docsify => It satisfy all my requirement
A few days later:
I want the readers to be able to play with the examples directly on the documentation page..
It simple, just embed a codepens, jsbin, plunkr.. => no, my library is not evens published yet, the live-sample should use the library on my localhost. [Goolge Playground Element] was the only option for my requirement
Now I need to embeded the Google Playground Element to my docsify page. The right way to do it was