docsify VS VuePress

Hello, FYI: I used https://docsify.js.org/ that turns markdown files into a static website without the need of building the site locally or in a CI. Example config. my 2c.

After reading your post again and this comment, I don't think Jekyll is the best choice. Something like GitBook, MkDocs, or Docsify would be a better solution as they let you control the organization and flow much better.

Docsify

On a new side project I'm working on I need to have a fair amount of documentation for usage, implementation, options, etc. In the past I've used https://docsify.js.org hosted on Vercel, but I was curious if there is anything else out there people like. Looking for free or paid options. So long has I can host on a subdomain I'm indifferent.

Thanks!

Docsify is a client-side only documentation generator. As a user requests a documentation page, it would fetch the associated .md file and render it all client-side. That meant that our documentation deployment process was simple again, as we could just push changes to the main branch and BOOM they would show up within seconds.

+1 more for Docsify and its Github repo. I know this subreddit is for self-hosted things, however I wanted to add Docsify works well with Github Pages (they host, you plug in your domain or subdomain).

https://docsify.js.org/#/ SSGs are too complicated.

Also, I can't find a good static site generator. VuePress(v1) or Gridsome isn't updated anymore, I had some problems developing. Nuxt 3 looks very good but it is still in beta(Had a lot of problems).Do you have any you can suggest? Looking here, other solutions don't appeal to me neither. I am thinking of VuePress Next(still beta but looks good. Tell me if you tested and think that they are production ready) or Vite static deploy.

In this article, I'll give several examples of sites I've created using Vue and VuePress, a popular way to build static sites with Vue. I'll also walk through a game engine we created in VuePress that you can deploy as a SWA, and touch on the use of Vite.js, a lightning-fast toolkit you can use to build all types of applications, built by the masterminds behind the Vue.js projects.

Just kidding, although using both I still prefer React over Vue fwiw. There totally is, look at VuePress as it’s essentially the same thing, but for Vue obviously.

Four years after creating VuePress, Evan You came back with a new SSG, VitePress. “VitePress is VuePress’ little brother, built on top of Vite.”

VuePress

The first thing we need to do is create a new VuePress project. It's really easy with the latest version of npm or yarn. From the VuePress docs

https://vuepress.vuejs.org/ to turn markdown into a static site and https://www.diagrams.net/ or https://mermaid-js.github.io/mermaid/#/ for diagrams.

We use https://vuepress.vuejs.org/ which takes Markdown and turns it into .html pages - so long as they have the git repository locally then they can either look at the Markdown itself or spin up the local dev environment for it.

We (Handsontable) now use VuePress[1] for our docs[2] and we are very happy with it. The best feature for us is the ease of customization.

Our challenge right now is to get a better code snippet runner, but that's beyond the scope of your regular documentation management tool, I suppose.

[1] https://vuepress.vuejs.org/

Using VuePress to organize and include interactive elements. Currently the site is built on GitHub and deployed to Netlify