16

Sphinx-docを使用するindex.rstと、含まれている他のファイルから目次を自動生成する目次マクロを含むファイルとconf.py、コンパイル構成として機能するを含む一連の ReStructureText ファイルを作成できます。次に、そのロットを単一の python-doc スタイルのサイトにコンパイルし、インデックス、ナビゲーション ツール、および検索機能を完備させることができます。

マークダウン (できれば pandoc スタイルのマークダウン) に匹敵するツールはありますか?

4

3 に答える 3

8

Pandoc、GNU makeおよびsedコマンドにいくつかのCSSを適用するだけで、 Markdownから始まる静的 Web サイトの作成を完全に自動化できます。

Pandoc は、ページ内の見出しに基づいてページ間のナビゲーションと目次 (TOC) の作成を提供できる 3 つのコマンド ライン オプションを提供します。CSS を使用すると、ナビゲーションと TOC の外観と動作を思い通りにすることができます。

-B FILE, --include-before-body=FILE

FILE の内容をドキュメント本文の先頭にそのまま含めます (たとえば、HTML のタグの後、または LaTeX の \begin{document} コマンドの後に)。これを使用して、HTML ドキュメントにナビゲーション バーまたはバナーを含めることができます。このオプションを繰り返し使用して、複数のファイルを含めることができます。それらは、指定された順序で含まれます。--standalone を意味します。

--toc, --目次

自動生成された目次を含めます。

--toc-depth=NUMBER

目次に含めるセクション レベルの数を指定します。デフォルトは 3 です (これは、レベル 1、2、および 3 ヘッダーがコンテンツにリストされることを意味します)。

実際のところ、私の個人的なウェブサイトはこのように構築されています詳細については、 makefileを確認してください。これはすべて、 GNU GPL バージョン 3の下でライセンスされたフリー・リブレのオープンソースです。

于 2014-01-28T12:42:44.273 に答える
2

Pandoc を使用しなくても問題ない場合は、mkdocsがニーズに合っているようです。

Pandoc 風の Markdown を確実に使用したい場合は、pdsiteをチェックしてください。より多くの入力形式 (emacs org-mode など) を使用し、Python の依存関係なしで mkdocs スタイルのサイト生成を取得する方法として作成しました。Markdown ファイルのフォルダーを渡し、HTML サイトを取得します (自動生成されたマルチを含む) -レベルのナビゲーション リンク)。これは単なるシェル スクリプトであるという点で、Serge Stroobandt のアプローチに似ています (treeただし、インストールする必要があります)。残念ながら、検索機能はまだありませんが、追加するのはそれほど難しくありません...

于 2016-06-27T22:23:59.340 に答える