Documentation is the most needed deliverable for any product or project. Sometimes, documentation is the deciding factor while choosing between two equally good frameworks/libraries in the open-source community.

Markdown played a major role in encouraging developers to do quick documentation without leaving their IDE. Importantly, Markdown fits well into the Git/source code control.

A new kind of documentation has started, which provides an interactive playground. Developers can explore the features of the product/components and can copy the code snippet. For example, check the following Vuetify component page

_Storybook _allows documenting your component using Markdown and JSX (MDX). Storybook’s inflexibility and mix-up of testing scope make it a second choice for documentation.

If you like the new generation documentation, but don’t have time to create the boilerplate code required, don’t worry. VuePress is there for your rescue.

Finally, you would prefer to host the static pages for everyone’s access. GitHub covers the base for you.

**Getting Started with GitHub Pages **— Reference

• Create a new GitHub account (if required)
• Create a new public repository named username.github.io, where username is your username (or organization name) on GitHub.

#vuepress #vuejs #markdown #github