6

I've been playing with YUIDoc and I find it fantastic.

By the way, I don't find a way to define my own main page content for the auto-generated documentation site (custom content inside the auto-generated index.html).

How can I define the main page content - if this is possible, of course -?

Thank you in advance!

Matías Fidemraizer
  • 63,804
  • 18
  • 124
  • 206

1 Answers1

7

YUI Doc is quite themable, so in theory this should be quite easy:

Fork YUI Doc or modify your current YUI Doc installation.

  • Add your own theme under yuidoc/themes. Copying the default theme is probably a good place to start, or copy over the partials/files you want to override.
  • In index.handlebars you add your custom content.
  • You can also change the main.handlebars to include custom CSS, JS and/or markup.

When you now build the docs, use the --themedir switch to use your new theme:

$ yuidoc --themedir ./mytheme

Read more: On YUI Doc theming.

Jonas G. Drange
  • 8,749
  • 2
  • 27
  • 38
  • Yeah, you're right. I forgot to auto-answer, or just drop the question, I found this some days ago. Anyway, because the answer is useful, it's a good reason to keep the Q&A for other visitors! Thanks :D – Matías Fidemraizer Apr 06 '13 at 08:26