Size of yuidoc module and generated docs

17 views
Skip to first unread message

Joe Malin

unread,
Apr 13, 2015, 7:14:50 PM4/13/15
to yui...@googlegroups.com
I've noticed that the latest version of Yuidocjs is a bit bloated:
  1. Its node_modules include yui, which seems to be JavaScript for yui itself, and not yuidoc. Surely the entire library isn't needed for code that isn't part of yui! Could someone on the yui side come up with a smaller module? It's not causing me problems, but cruft is cruft.
  2. The output from yuidoc doesn't minify or uglify its JavaScript libraries. This is a real problem. Distributing yuidoc output or even hosting it on a server is a problem if it isn't minimized as much as possible.

Ryuichi Okumura

unread,
Apr 14, 2015, 8:38:01 AM4/14/15
to yui...@googlegroups.com
Regarding 1, you're right, but it's a critical issue for now. I've filed an issue related with this, please see the following issue for more information.

Regarding 2, I'm not sure about this. There're a few JavaScript code within results of YUIDoc, but it seems to be of modest size. Anyway, I think we should take a look on this if that is a problem.

$ ls -l out/assets/js/*.js
-rw-r-xr-x  1 okuryu  staff   1445  4  9 20:33 out/assets/js/api-filter.js
-rw-r-xr-x  1 okuryu  staff   6568  4  9 20:33 out/assets/js/api-list.js
-rw-r-xr-x  1 okuryu  staff   2924  4  9 20:33 out/assets/js/api-search.js
-rw-r-xr-x  1 okuryu  staff  10297  4  9 20:33 out/assets/js/apidocs.js
-rw-r-xr-x  1 okuryu  staff    482  4  9 20:33 out/assets/js/yui-prettify.js

-- Ryuichi


--
You received this message because you are subscribed to the Google Groups "yuidoc" group.
To unsubscribe from this group and stop receiving emails from it, send an email to yuidoc+un...@googlegroups.com.
To post to this group, send email to yui...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/yuidoc/2791f2fc-f2d3-4493-8a1b-2e5792cbe14e%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Joe Malin

unread,
Apr 14, 2015, 1:05:07 PM4/14/15
to yui...@googlegroups.com
In regard to 1, this issue is definitely more important. Did you send me a link to it? I don't see it.

In regard to 2, I have the following list.

rw-r-xr-x  1 JoeMalin staff  1445 Apr  9 14:29 api-filter.js*
-rw-r-xr-x  1 JoeMalin staff  6568 Apr  9 14:29 api-list.js*
-rw-r-xr-x  1 JoeMalin staff  2924 Apr  9 14:29 api-search.js*
-rw-r-xr-x  1 JoeMalin staff 10297 Apr  9 14:29 apidocs.js*
-rw-r-xr-x  1 JoeMalin staff   482 Apr  9 14:29 yui-prettify.js*
-rw-r-xr-x  1 JoeMalin staff  8973 Apr  9 14:29 yuidoc-bootstrap.js*

I suspect that yuidoc-bootstrap.js is coming from a theme I'm using. I'm building reference docs separately for each module I use, but I can clean this up in a build.





For more options, visit https://groups.google.com/d/optout.



--
Joe Malin
Technical Writer
______________________________________

"A farmer and her daughter observed the strange scene of a figure in a bright orange suit with a large white helmet landing near them by parachute. Gagarin later recalled, "When they saw me in my space suit and the parachute dragging alongside as I walked, they started to back away in fear. I told them, don't be afraid, I am a Soviet citizen like you, who has descended from space and I must find a telephone to call Moscow!" -- Wikipedia, Vostok 1


Ryuichi Okumura

unread,
Apr 15, 2015, 10:19:17 AM4/15/15
to yui...@googlegroups.com
In regard to 1, this issue is definitely more important. Did you send me a link to it? I don't see it.


Reply all
Reply to author
Forward
0 new messages