2013-04-01 23 views
6

Gram z YUIDoc i uważam, że jest fantastyczna.Jak zdefiniować niestandardową stronę główną w dokumentacji generowanej przez YUIDoc?

Nawiasem mówiąc, nie znajduję sposobu, aby zdefiniować własną zawartość strony głównej dla automatycznie wygenerowanej strony z dokumentacją (niestandardowe treści wewnątrz automatycznie wygenerowanego index.html).

Jak zdefiniować zawartość strony głównej - , jeśli jest to możliwe, oczywiście -?

Z góry dziękuję!

Odpowiedz

7

YUI Doc jest dość themable, więc teoretycznie powinno to być dość łatwe:

Fork YUI Doc lub modyfikować bieżącą instalację YUI Doc.

  • Dodaj własny motyw pod numerem yuidoc/themes. Kopiowanie domyślnego motywu jest prawdopodobnie dobrym początkiem, lub skopiuj części/pliki, które chcesz przesłonić.
  • W index.handlebars dodajesz swoją niestandardową treść.
  • Można także zmienić main.handlebars, aby uwzględnić niestandardowe arkusze CSS, JS i/lub znaczniki.

Kiedy teraz budować dokumenty, należy użyć przełącznika --themedir do korzystania z nowego motywu:

$ yuidoc --themedir ./mytheme 

Czytaj więcej: On YUI Doc theming.

+0

Tak, masz rację. Zapomniałem odpowiedzieć automatycznie, lub po prostu upuścić pytanie, znalazłem to kilka dni temu. W każdym razie, ponieważ odpowiedź jest przydatna, jest to dobry powód, aby trzymać Q & A dla innych odwiedzających! Dzięki: D –

+0

Dobre rzeczy. Cieszę się, że to rozwiązałeś! :) –

+0

@JonasGDrange Tak, dzięki! YUIDOC skały! –