search

clenemt / docdash

:zap: Lodash inspired JSDoc 3 template/theme
http://clenemt.github.io/docdash/
Other
824 stars 201 forks source link

Add hyphenation hints on compile time & use text justification #65

Open koraa opened 5 years ago

koraa commented 5 years ago

This commit adds proper hyphenation hints to the documentation at doc compile time; these hints can be used to portably use text-align: justified with nice hyphenation.

This looks nice & fits more information, especially on small screens.

ar2rsawseen commented 5 years ago

While I am not against justifying the text (with hyphenation or without) one thing that concerns me is forced hyphenation for English language. And yes, I know, most of the docs are written in English either way, and I would agree and call it a bad habit of writing comments in other than English. But in overall, it would be great if we supported such option still and let up to the end user to decide language.

So my question would be, how it would behave with different languages, especially the ones with different character set, like chinese?

koraa commented 5 years ago

I have no idea to be honest… There are multiple language support switches for the hyphenation package, we would have to make the lang configurable…