Skip to main content

Host Documentation on GitHub Pages with VuePress

Dorin Andrei DraganLess than 1 minutedocumentationdocumentationvuepressgithub-pages

Host Documentation on GitHub Pages with VuePress

I use VuePress for the documentation site because is simple. For the VuePress site I will be using the vuepress-theme-hopeopen in new window Vuepress theme which is awesome.

Install prerequisites

Install VuePress and the VuePress theme.

npm init vuepress-theme-hope docs

Install packages for plugins

Mermaid

npm i -D mermaid

For more details see how to setup Mermaidopen in new window for vuepress-theme-hopeopen in new window.