問題タブ [mkdocs]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
markdown - mkdocs で上付き文字をレンダリングする
こんにちは、マークダウン エディターとして Typora を使用し、ドキュメンテーション プロジェクトを構築するために mkdocs を使用しています。マークダウン構文で上付き文字を次のように表すために使用していますが、
service_command ^文字列、必須^
Typora では完全に正しく表示されます。しかし、mkdocs を使用してプロジェクトをビルドすると、基本的な html に上付き文字が表示されません。手動で html コードを変更して上付き文字を表示できることはわかっています。しかし、mkdocs で上付き文字を正しくレンダリングする方法を探しています。私も使ってみましたタグを使用して同じことを実現しますが、mkdocs は上付き文字をレンダリングできません。
mkdocs が生成するサンプル HTML コードは次のとおりです。
これは、mkdocs で生成された html ページ ビューです。
Typoraがプレビューを表示する方法は次のとおりです
markdown - mkdocs nav タイトルがページ タイトルと異なる
私のmkdocs.ymlファイルにはnav、左側のナビゲーションでそれぞれ 1 行だけに収まるように短縮されたタイトルが含まれており、.mdMarkdownページのタイトルを省略されていないフルレングスのタイトルにしたいと考えています。
たとえば、私のmkdocs.ymlファイルには次のものが含まれています。
.mdページのタイトルを次のようにしたい:
mkdocs.yml...ナビゲーション タイトルをコピー/使用する代わりに:
ファイルの 1 行目 ( # Big Data...) にMarkdown ページ タイトルを追加すると、必要なページ タイトルと継承されたタイトルの両方が取得されます。.mdmkdocs.yml nav
別の/2番目の「ページ表示」名を指定するための答えはmkdocs.ymlファイルにあるようですが、多くのGoogle検索では何も見つかりませんでした。
他にどのような方法を試したり、聞いたりしましたか? ありがとう！
plugins - MKDocs プロジェクトにプラグインを実装するには?
アップデート！！！！
インデントに注目！コード エディターでプラグイン セクションがインデントされていたため、パッケージ テーマの一部として読み込まれました。少なくとも 1 つのプラグインが動作するようになったので、少し正気を感じています。次に、他のものをデバッグします...
他の誰かが同じ間違いを犯した場合に備えて、これを残しておいてください!
参考までに：
MKDocs 1.0.4 ピップ 19.2.3 Python 3.8.1
別の同僚の開発者が私に気付くのに時間がかかったので、元のコードを投稿しなかったことをお詫びします。
元の投稿:
切断がどこで発生したかはよくわかりませんが、プラグインのインストールに関する MKDocs の指示に従って 10 回実行したのに、実際に何かが機能するのをまだ確認していないような気がします。構成ファイルに追加する前に、目的のプラグインを最初にインストールするようにしました。
これらは、他のものを試す前に、現時点で取り組んでいる 2 つです。
1: PDF エクスポート プラグイン
ピップは、正常に動作するように見えるものをインストールしました。mkdocs.yml ファイルのプラグイン セクションの下に pdf-export プラグインを追加し、再構築、--clean を使用して再構築、およびさまざまな組み合わせで予約しましたが、PDF ドキュメントが自動的に生成される必要があると通知された場合ビルド コマンドでは、何も表示されません。
- Git 改訂日
ピップは、正常に動作するように見えるものをインストールしました。{{ git_revision_date }} の部分を index.md ファイルに追加して、何が生成されるかを確認しました。ブラウザを介してコードを出力するだけです。
ヘルプ？！
他の場所に何か追加する必要がありますか? どのプラグインも応答を示さないため、何かが足りないように感じます。MKDocs のドキュメントと個々のプラグインのドキュメントを調べましたが、これまでのところ何も見つかりませんでした。
html - ローカルの html リンクが .html ではなく親フォルダーに移動するのはなぜですか?
編集：ウェイランの答えはうまくいきました！ありがとう！
ドキュメントの .html ファイルを圧縮して顧客に送信しようとしています。目標は、実際の Web サイトをナビゲートするのと同じ体験をすることです。
.html ファイルを開くと、クリックされたリンクは、特定の .html ではなく、親フォルダーに移動します。たとえば、構成ページへのリンクをクリックすると、実際のページへの index.html を含むこの親フォルダー (画像に表示) に移動します。これは、(MkDocs を使用して) ビルドされた .md をナビゲートしているときではなく、.html ファイルを処理しているときにローカル インスタンスでのみ発生します。
- macOS カタリナ、10.15.3
- MkDocs
- マークダウン