Geek Answers Handbook

How to define a custom master page in the documentation generated by YUIDoc

I played with YUIDoc and I find it fantastic.

By the way, I did not find a way to define my own content on the main page for a site with automatically generated documentation (user-generated content inside automatically generated index.html ).

How can I determine the content of the main page - if possible, of course?

Thank you in advance!

+6
source share
1 answer

YUI Doc is quite applicable, so theoretically this should be pretty simple:

Fork YUI Doc or change the current installation of YUI Doc.

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

When you are creating documents now, use the --themedir switch to use the new theme:

 $ yuidoc --themedir ./mytheme

Read more : In the YUI Doc tags .

+7
source

More articles:


All Articles