What is Reddit's opinion of Docsify.js?

From 3.5 billion Reddit comments

Yep, have downloaded and installed it, then went through the docs start to finish, testing its various configurations and features.

It's definitely going to be core part of the Vue ecosystem, especially for those who want to write docs.

I'd say that Docsify has the edge for ease of use, and is more useful getting up and running quickly for smaller projects, such as libraries. I prefer Docsify's markdown sidebar, as you generally don't need auto-linking when a your pages are well-structured and bite-sized.

You can also write plugins, jQuery style, in Docsify which makes it really easy to add new functionality. They hook into Vue's lifecycle hooks like afterEach, mounted, etc, then you can modify the generated HTML, such as upgrading links, adding a footer, etc.

VuePress has a much tighter integration with Vue though:

• you can customise everything if you "eject" the default theme, which gives you a folder of components
• you can supposedly add in-page interactive demos a bit more easily than Docsify (though I didn't really play with this yet)

It's only on version 0.43 or something, so I'd expect there's still room for improvement / maturity.

That functionality for a knowledge-base is excessive and unnecessary. Hosting static files is free/cheap and trivial. Hosting a webserver adds significant complexity and considerations like security that are realistically beyond your ability right now. You don't want that and they don't want that. In this situation you're getting all those drawbacks while still just serving webpages full of static text. I hope you consider taking some time to at least try to convince them of this.

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.

> The use case of this isn’t externally facing so I don’t need a compliant HTML structure.

You misunderstand. The reason you are struggling with the logic is because your data is not logically structured. It is the logic of semantically correct HTML lists that make them manageable by both humans and machines.

The docsify website uses semantically correct nested lists, as does every page I have checked from their showcase of docsify implementations.

This is a configuration issue on your end. It doesn't make sense that you have control over everything but the one thing you need to fix.

Hello, il se trouve que j'ai très récemment découvert et commencé à utiliser Docusaurus (v2, puisque c'est ce qui est recommandé pour les nouveaux projets), et j'ai un peu de mal à comprendre les choix techniques qui ont été faits. Le build génère des pages HTML statiques, et quand je vais sur le serveur, la SPA télécharge et affiche la page HTML... pour la remplacer par le même DOM, mais généré via React ?! J'ai du mal à comprendre l'intérêt du coup : deux fois plus de données téléchargées, des scores Lighthouse pas terribles à cause notamment d'un "Time to Interactive" important (lié à l'exécution du JS j'imagine).

Exemple sur une page de Docusaurus lui-même, dont le contenu est pourtant assez simple : https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fdocusaurus.io%2Fdocs%2Fen%2Fadding-blog

Si quelqu'un sait m'éclairer sur l'intérêt de ce comportement, je suis preneur :).

Je sais qu'il y a Docusaurus v1 qui correspond plus à ce que je cherche (des pages statiques et c'est tout), mais je m'interroge sur cette tendance bizarre (vuepress fait pareil j'ai l'impression).

docsify en fait même un argument de vente ! > No statically built html files

Si c'est du contenu statique, pourquoi le générer à la volée via du JS ?!

Not PDF for sure. Really want the documentation to be easy to edit so something like markdown or asciidoc works best.

And then use something web based for display. So github wiki or if you want to host yourself something like Docsify (https://docsify.js.org). Both of those use markdown.

Your public methods, fields, etc should have JavaDoc.

However, keep in mind JavaDoc has a different audience from user documentation. You need both.

It's not about Swagger/OpenAPI but AsyncAPI. And docsify is not a remedy for everything. And anyway what TypeScript has to do here? it is about event driven architectures, and not just simple schema docs.

​

btw I love https://docsify.js.org/#/ for no static HTML building :heart:

>Been really happy with https://docsify.js.org/#/

This looks promising however from what I understand on the docs page it has a requirement of using Github? Is that correct or can it be used standalone?

I can configure docsify to do that but it integrates it into the full sidebar TOC rather than being a separate pane somewhere on the page. I think we can write a plugin to do that but I haven't figured out how yet.

If you (anyone, not just /u/french_pressed) happen to be a frontend dev and would like to write a plugin for this it'd be a great way to contribute to QMK.

Looks like there is no longer a page contents sidebar, anyway to add that back in?

Also, I agree with others the option for a light theme would be nice as well. Otherwise everything looks great.

Edit: I took a quick look, there's an example of switching themes here

However, I can't find anything available to add a page content sidebar.