search

documentationjs / documentation

:book: documentation for modern JavaScript
http://documentation.js.org/
Other
5.79k stars 481 forks source link

Default HTML theme #1235

Open ai opened 5 years ago

ai commented 5 years ago

Docs says that default HTML theme looks like: http://documentation.js.org/html-example/ (it is a pretty beautiful theme, great work)

20190423231050

When I used npx documentation build *.js -f html -o docs/, I got

20190423231115

The style is very different. Should we update a theme in the docs? Or maybe I am using CLI wrong?

I personally like a theme from the docs. How I can get it?

➜ npx documentation --version
10.0.0
ai commented 5 years ago

Seems like the example was generated with documentation-theme-light?

Should we mention it in docs? Or use the default theme? Or maybe it will be better to change the default theme (light looks better in most of things)?

Zearin commented 4 years ago

Same issue. I even tried copying the default theme and tweaking it a bit, but it seems to be more than a quick afternoon hack session can fix.

sam3k commented 4 years ago

I've tried downloading the documentation-theme-light theme @ai mentioned, into the root of my app's directory, and then do documentation serve comp/static/index.js --watch --theme documentation-theme-light and I get the following error:

TypeError: require(...) is not a function

Anyways, I agree that the documentation-theme-light is a much better theme as it expands all the content right up-front. Also, it is very very confusing for new users to see an example of a theme, and no guidance is given to them as to how it was generated with that theme.