Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multiple remarks #252

Open
noraj opened this issue Jul 26, 2019 · 6 comments
Open

Multiple remarks #252

noraj opened this issue Jul 26, 2019 · 6 comments

Comments

@noraj
Copy link
Contributor

noraj commented Jul 26, 2019

@noraj
Copy link
Contributor Author

noraj commented Jul 26, 2019

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
Copy link
Contributor Author

noraj commented Jul 26, 2019

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
Copy link
Contributor Author

noraj commented Jul 26, 2019

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.

@noraj noraj changed the title Multiple remarks ❗ Multiple remarks Jul 26, 2019
@noraj noraj changed the title ❗ Multiple remarks Multiple remarks Jul 26, 2019
@noraj noraj changed the title Multiple remarks exclamation Multiple remarks Jul 26, 2019
@noraj noraj changed the title exclamation Multiple remarks ❗ Multiple remarks Jul 26, 2019
@noraj noraj changed the title ❗ Multiple remarks Multiple remarks Jul 26, 2019
@noraj noraj changed the title Multiple remarks ❗ Multiple remarks Jul 26, 2019
@noraj noraj changed the title ❗ Multiple remarks Multiple remarks Jul 26, 2019
@TheSimpleZ
Copy link

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
Copy link
Contributor Author

noraj commented Jul 29, 2019

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

@transitive-bullshit
Copy link

@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! 💕

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants