ドキュメントツール デモ¶
テーマチェックリスト¶
このデモは、BeeWare MkDocs Materialテーマの各種機能オーバーライドをテストするために設計されています。本ページおよび次ページに記載されているすべての項目が、説明通りに存在し機能していることを確認してください。
タイトルバー¶
ページには中程度の灰色のタイトルバーが表示されています。これはテーマテンプレートが適用されていることを示しています。
ヘッダーアイコン¶
ヘッダーアイコン（左上）がレンダリングされました。これにより、テンプレートが外部リソースを参照できることが確認されました。
ホームページサイドバーアイコン¶
左サイドバーのロゴアイコンは表示済みです。ロゴはサイドバーの幅と同じで、高さはサイドバーと同じである必要があります。サイトタイトルはロゴの下に、サイドバーの他の部分よりやや大きいフォントで表示され、その下にバージョン番号が小さいフォントで表示されるべきです。
これにより、サイドバーが対象サイトで正しく表示されることが確認されました。
見出しフォント¶
見出しはイタリック体で表示されます。これはBeeWareカスタムCSSテーマが適用されていることを確認します。
インラインコード¶
インラインコードは周囲のフォントと同じ色で表示されます。これにより、テーマが意図しない変更を引き起こしていないことが確認できます。
これはここにinline codeがあり、ここにinline codeがあるテキストです。
タブ付きコンテンツコード¶
コードは背景色と対照的な色で表示されます。コピーボタンはコマンドのみをコピーし、プロンプトは含めないでください。
この確認により、テーマが意図しない変更を引き起こしていないこと、およびコピーボタンが期待通りに動作していることが確認されます。
$ git clone https://github.com/beeware/beeware-theme.git
$ git clone https://github.com/beeware/beeware-theme.git
C:\...>git clone https://github.com/beeware/beeware-theme.git
コードコピーボタンの動作¶
以下のコードブロックのコピーボタンをクリックすると、from pathlib import Path がクリップボードにコピーされるはずです。
from pathlib import Path
以下のコードブロックのコピーボタンは、ls beeware-docs-tools
をクリップボードにコピーする結果となるべきです。シェルプロンプトと出力は含めないでください。
(venv) $ ls beeware-docs-tools
_build locales requirements.dev.txt tox.ini
docs pyproject.toml requirements.docs.txt
LICENSE README.md src
サイドバーリンク¶
サイドバーリンクが存在し、beeware-docs-toolsリポジトリを指しています。これは、サイドバーコンテンツが読み込まれ、MkDocs設定ファイルでproject-nameが設定され、バージョン番号が計算されて追加されたことを確認します。
リンクの色¶
このBeeWareのメインウェブサイトへのリンクは、ライトモードとダークモードの両方で青色であるべきです。
左右のサイドバーにあるリンクも、両方のモードで青色であるべきです。
ページをスクロールダウンする際、右サイドバーのアクティブなヘッダーリンクは、ダークモードでは薄い青、ライトモードでは濃い青になるべきです。
翻訳に関する注意¶
この文書の英語版には、以下の「翻訳が利用可能です」という注意書きを表示してください。フランス語訳には「これは機械翻訳です！」という注意書きを表示してください。ドイツ語訳には、人間による翻訳に対して「これは翻訳です！」という注意書きを表示してください。
これは機械翻訳です！
このチュートリアルのバージョンは機械翻訳によって生成されました。理想的ではないことは承知していますが、翻訳がないよりは悪い翻訳がある方がましだと考えました。
カスタム404ページ¶
ブラウザのURL末尾にnopageを追加し、404ページが存在し、「Brutus can't find what you're looking
for」というテキストが含まれていることを確認してください。現在の404ページは、MkDocsの問題により画像が常に表示されるとは限りません。
MkDocsのビルドは認識されない内部リンクで失敗するため、ブラウザでURLを変更してこのチェックを手動で確認する必要があります。
次のチェック¶
以下のリンクは、BeeWare Docs Tools デモ セクション 1 に移動するはずです。これは、ページ間のリンクを検証するために含まれています。
次のチェックについては、BeeWare Docs Tools デモ セクション 1 に移動してください。