問題タブ [mkdocs]

mkdocs を使用して、マークダウンから hendrix ドキュメントを作成しています。

readthedocsに表示される場合、ドキュメントには見出しのアンカー リンクがありません。

github で mkdocs を使用するには?

メインリポジトリから複製されたリポジトリがあります。その場合、ドキュメントをプッシュするにはどうすればよいですか (私は Windows で Git を使用しています)。

API ドキュメントを Markdown で記述し、MkDocs を使用して静的サイトを生成する傾向があります。ただし、ドキュメントをホストしたいサイトは Django サイトです。私の質問は、グーグルで答えが見つからないようです.MkDocs静的生成サイトファイルを次のような場所にホストし、/api/v1/docsそのURLで静的サイトを表示できるようにするにはどうすればよいですか?

更新: 私は Apache の下ですべての静的ファイルを提供し、runserver またはデバッグ モードを使用して静的ファイルを提供しないことを指摘しておく必要があります。このサイトは完全に構築されており、REST API と連動しています。

私の質問は、特定の URL で MkDocs によって生成された静的サイト (API ドキュメント用) を Django (または Apache と言うべきか) に提供するにはどうすればよいかということでした。サイトのメディア ファイルと静的ファイルを提供する方法は理解していますが、MkDocs が生成するものを提供する方法は必ずしも理解していません。HTML とアセット ファイルを含む完全に静的な「サイト」ディレクトリを生成します。

ここで mkdocs セットアップ プロセスに従っています: http://www.mkdocs.org/#installation

ローカル マシンにインストールした後は、mkdocs に何かをさせることができません。最新の python と pip をインストールしました。mkdocs パッケージがインストールされていることを確認しましたが、まだ何もありません:

OSX で mkdocs を実行するために必要な追加の手順はありますか?

少なくとも人気があるのは明らかですが、mkdocs ディレクトリ内の「メイン」ファイルは index.md と呼ぶ必要がありますか? 別の場所にあるファイル フォルダ (つまり、このファイルの階層の一部ではない) にあるドキュメントを参照するとどうなりますか? 他の場所にあるリンクされたファイルにわずかな問題があるので質問します。私が見つけたネット上には、これに関するドキュメントはほとんどありません。どうも

Mkdocs または Sphinx で次のようなタブ付きコード ブロックを作成する方法はありますか?

含まれている ReadtheDocs テーマから、プロジェクトの bootswatch United テーマに切り替えました。私はpip install mkdocs-bootswatchこのテーマを作成し、ファイルに変更theme: readthedocsしました。theme: unitedmkdocs.yml

ただし、プロジェクトは Read the Docs で正常にビルドされますが、ドキュメントは標準の readthedocs テーマを保持します。ローカルで ( を使用してmkdocs serve) 実行すると、United テーマで正しく表示されます。

どこかを調整する必要がある別のコード行はありますか? 追加する必要がある要件ファイルは? 外部テーマを ReadtheDocs に適切に表示するにはどうすればよいですか? または実際、readthedocs.org で外部テーマを使用することもできますか?

注: MkDocs の関係者に尋ねたところ、ReadTheDocs の制限であるとのことでした。そのため、何かすることがあれば、ReadTheDocs 関連の解決策になるようです。そうしないと、GitHub ページなどに切り替える必要があるかもしれません。