Multiple remarks

[noraj]

• https://docute.org/ : quick start is not talking about installation, it's not talking about npm i docute or about steps from git etc.
• https://v3.docute.org : the quick start talks about docute init ./docs and docute-cli so it more understandable.
• docute-cli seems abandoned after the v3
• It's lacking of a search feature #21, #232
• On v3, the sidebar bottom is glitched:

[noraj]

https://docute.org/#quick-start

I did

1. npm i docute.
2. cp node_modules/docute/dist/* docs
3. nvim docs/README.md
4. python -m http.server -b docs

And I just have a white page.

My tree in /docs:

README.md
index.html
docute.css
docute.js

[noraj]

https://docute.org/guide/customization#navbar

Ok there is an example of navbard and sidebar but in which file do I put them? In the minified docute.js?

As all files from the dist (npm) are minified it is hard to beatify them, requiring the use of a nodejs beautifier to be able to edit the configuration.

[noraj]

I installed and use tons of static site generator and static documentation builder but I'm not able to make docute work by reading the documentation. The documentation may be unclear.

The v3 documentation is more clear about what to do: https://v3.docute.org/ but doesn't work for the v4.

[TheSimpleZ]

In v4, you should not use the npm package. Simply copy the index.html file mentioned in the Quick Start in to your docs folder, next to your README.md. Then serve is as a static website. That's all you should need.

[noraj]

As the documentation was not clear enough and the project lacking of a search feature I finally used docsify.

[transitive-bullshit]

@noraj's comments are on point. Really interested in using this project, but the default v4 demo doesn't include search or scroll spy which seem like they should be enabled by default in the demo that's trying to convince developers to use this library.

Aside from these issues, this is an amazing lib and I'd hate to see other devs using other solutions because of relatively simple changes to the default docs.

Thanks for all the hard work put into this! 💕