2013-03-14 11 views
14

Dzięki Sphinx-doc można utworzyć kilka plików ReStructureText z plikiem index.rst, który zawiera makro spisu treści, które automatycznie generuje spis treści z innych dołączonych plików, oraz conf.py, który działa jako konfiguracja kompilacji. Następnie możesz skompilować partię w jedną stronę w stylu Pythona, wraz z indeksem, narzędziami nawigacyjnymi i funkcją wyszukiwania.Cała kompilacja strony markdown/pandoc?

Czy istnieje porównywalne narzędzie do przeceny (najlepiej obniżka w stylu pandoc)?

+1

Czy istnieje również narzędzie do dokumentacji (obniżania), które może produkować pliki PDF i ePub tak łatwe, jak robi to Sphinx? –

+0

@white_gecko Edytuj w [Markdown] (http://daringfireball.net/projects/markdown/syntax#overview), przekonwertuj na XHTML za pomocą [pandoc] (http://johnmacfarlane.net/pandoc/README.html) i na końcu przekonwertuj na PDF za pomocą [PrinceXML] (http://www.princexml.com/), którego możesz używać lub nie za darmo (patrz [Licencja CSO] (http://www.princexml.com/license/)) . Ponownie sprawdź [moja strona] (http://hamwaves.com/cl-ocfd/en/index.html), aby uzyskać szczegółowe informacje. Istnieje alternatywa typu open-source o nazwie [wkhtmltopdf] (http://wkhtmltopdf.org/), która jednak nie jest dobra w łamaniu strony. –

Odpowiedz

9

Niektóre generatory statyczne witryny, które współpracują z promocji cenowych:

myślę, żaden z nich korzystać pandoc (może dlatego, że jest napisane w Haskell), ale wszystkie one używać składni Markdown zwiększoną lub może być skonfigurowany do korzystania pandoc.

Inne interesujące sposoby generowania witrynę z obniżki:

  • Markdown- Wiki które są oparte pliku: f.ex. Gollum, silnik Wiki, który jest również używany przez GitHub
  • Telegram: komercyjny; napisany przez Davida Pollak, wynalazca Lift-Scala-ramowej

silników, które wykorzystują Pandoc:

Ostateczne zestawienie statycznej strony Generatory

Dobry przegląd statycznych generatorów strony: http://staticsitegenerators.net/

+0

Hyde to w zasadzie CMS, prawda? Nie chcę czegoś, co muszę zostawić runnning. Niektóre inne wyglądają jednak interesująco, dzięki za listę! – naught101

+1

O ile wiem, Hyde produkuje również statyczny HTML, tak jak Jekyll. – Sonson123

+1

Dla tych, którzy przychodzą po mnie: Pelikan jest fajny, ale jego celem jest blog, a nie statyczna strona, tak jak sfinks. – naught101

7

Pandoc, GNU make i sed polecenia, posypane jakimś CSS to wszystko czego potrzebujesz w pełni zautomatyzować tworzenie statycznej strony internetowej zaczynając od Markdown.

Pandoc oferuje trzy opcje wiersza poleceń, które umożliwiają nawigację między stronami, a także tworzenie spisu treści (TOC) na podstawie nagłówków na stronie. Dzięki CSS możesz sprawić, że nawigacja i spis treści wyglądają i zachowują się tak, jak chcesz.

-B FILE, --include-przed-body = PLIK

Dołącz zawartość pliku, dosłownie na początku treści dokumentu (np po tagu w HTML lub \ begin { document} w LaTeX). Można to wykorzystać do umieszczenia pasków nawigacyjnych lub banerów w dokumentach HTML. Ta opcja może być wielokrotnie używana w celu uwzględnienia wielu plików. Zostaną one uwzględnione w podanej kolejności. Implies --standalone.

--toc, --table-of-zawartość

Dołącz automatycznie wygenerowanego spisu treści.

--toc głębokości = liczba

Określanie liczby poziomów umieścić w spisie treści. Wartość domyślna to 3 (co oznacza, że ​​nagłówki poziomu 1, 2 i 3 zostaną wyświetlone w treści).

W rzeczywistości my personal website is built this way. Sprawdź jego numer makefile, aby uzyskać więcej informacji. To licencja open-source na licencji open-source pod numerem GNU GPL version 3.

+1

Er ... te opcje TOC odnoszą się do nagłówków * w * pliku oceny. Mówię o spisie treści w wielu plikach, z których każda jest osobną stroną. Twoja strona internetowa to pojedyncza strona ... – naught101

+0

@ naught101 Edytowałem swoją odpowiedź. Nawigacja między stronami może być łatwo obsługiwana za pomocą opcji '--include-before-body = FILE'. –

+0

Nie, brakuje ci punktu.Sphinx-doc umożliwia zapisanie wielu stron * jako oddzielnych plików *, a następnie generuje plik HTML dla każdej strony (z TOC na pasku bocznym), a także pełny plik HTML TOC (który nie ma Źródło .rst, ale wygenerowane automatycznie). O to właśnie pytam. – naught101

1

Jeśli nie używasz Pandoc, mkdocs wydaje się pasować do twoich potrzeb.

Jeśli na pewno chcesz użyć Markdown o smaku pandoc, możesz wypróbować pdsite. Napisałem to jako sposób na wygenerowanie strony w stylu mkdocs z większą ilością formatów wejściowych (jak tryb emacs org) i bez zależności Pythona - przekazujesz folder plików Markdown i wyciągasz stronę HTML (w tym automatycznie generowaną wiele poziomy nawigacji nawigacyjnej). Jest podobny do podejścia Serge'a Stroobandta, ponieważ jest to po prostu skrypt powłoki (wymaga on jednak zainstalowania tree). Niestety nie ma jeszcze funkcji wyszukiwania, chociaż nie byłoby to zbyt trudne do dodania ...