API参照
注
APIのメインのエントリポイントは、プラグインによって受信されるイベントです。これらのイベントの説明は、このページにリンクされています。
mkdocs.structure.files.Files
ファイルオブジェクトのコレクション。
src_paths: dict[str, File] プロパティ
非推奨、src_urisを推奨しています。
__iter__() -> Iterator[File]
内側のファイルを反復します。
__len__() -> int
内側のファイル数。
__contains__(path: str) -> bool
非推奨、get_file_from_path(path) is not Noneを推奨しています。
append(file: File) -> None
ファイルコレクションにファイルを追加します。
remove(file: File) -> None
ファイルコレクションからファイルを削除します。
copy_static_files(dirty: bool = False, *, inclusion: Callable[[InclusionLevel], bool] = InclusionLevel.is_included) -> None
ソースから宛先へ静的ファイルをコピーします。
documentation_pages(*, inclusion: Callable[[InclusionLevel], bool] = InclusionLevel.is_included) -> Sequence[File]
全Markdownページファイルオブジェクトの反復可能なコレクションを返します。
static_pages() -> Sequence[File]
すべての静的ページ ファイル オブジェクトの反復可能を返します。
media_files() -> Sequence[File]
ドキュメントや静的ページ以外のすべてのファイル オブジェクトの反復可能を返します。
javascript_files() -> Sequence[File]
すべての JavaScript ファイル オブジェクトの反復可能を返します。
css_files() -> Sequence[File]
すべての CSS ファイル オブジェクトの反復可能を返します。
add_files_from_theme(env: jinja2.Environment, config: MkDocsConfig) -> None
Jinja 環境から静的ファイルを取得してコレクションに追加します。
mkdocs.structure.files.File
MkDocs ファイル オブジェクト。
ファイルの内容がターゲット サイトにどのように populate されるべきかを表します。
`abs_dest_path`(dest_dir`と`dest_path`を連結することで取得されます) のファイルは常に存在します。ここでは`dest_dir`がサイト ディレクトリであると認識されています。
ファイルのコンテンツを取得するには、いつでも`content_bytes`/`content_string`(MkDocs 1.6 の新機能) を使用できます。しかし、2 つのソースのうちの 1 つでサポートされている可能性があります。
-
`abs_src_path`(デフォルトでは、`src_dir`と`src_uri`を連結することで取得されます) の物理ソース ファイル。`src_dir`はドキュメント ディレクトリであると認識されています。
この場合、`content_bytes`/`content_string`は`abs_src_path`のファイルを読み取ります。
実ファイルに対しては`src_dir`を populate すべきであり、生成されたファイルに対しては`src_dir`は`None`であるべきです。
-
MkDocs 1.6 以降、ファイルはメモリ (`content_string`/`content_bytes`) にも保存できます。
この場合、`src_dir`と`abs_src_path`は`None`のままになります。コンストラクタの`content`引数を通じて`content_bytes`/`content_string`に値を書き込むか、populate する必要があります。
しかし、そのようなファイルでも、`src_uri`は引き続き populate されます。仮想ファイルは、`src_uri`が`docs`ディレクトリ内のパスに由来していると仮定して機能し、他の値は`use_directory_urls`に基づいて導出されます。
静的ファイルの場合は、ファイルは単純に destination (アクセス先) にコピーされ、`dest_uri`は`src_uri`と等しくなります。
Markdown ファイル (src_uri`のファイル拡張子で決まります) の場合は、アクセス先のコンテンツがレンダリングされたコンテンツになり、`dest_uri`は `.html`拡張子を持ち、`use_directory_urls`に基づいてパスに追加の変換が加えられます。
src_uri: str インスタンス属性
ソース ディレクトリ相対のソース ファイルの純粋なパス(常に'/'で区切られます)。
generated_by: str | None = None クラス属性 インスタンス属性
`None`以外の場合は、プラグインがこのファイルを自動的に生成したことを示しています。
値はプラグインのエントリポイント名であり、キーで PluginCollection 内のプラグインを検索するために使用できます。
dest_path: str プロパティ 書き込み可能
dest_uri と同じ(それと同期される)が、Windowsではバックスラッシュを使用する。非推奨。
src_path: str = path インスタンス属性 プロパティ 書き込み可能
src_uri と同じ(それと同期される)が、Windowsではバックスラッシュを使用する。非推奨。
src_dir: str | None = src_dir インスタンス属性
ソースファイルがwhereから生成されたかの、トップレベルディレクトリのOSパス。
docs_dirであると想定され、生成されたファイルには設定されない。
dest_dir: str = dest_dir インスタンス属性
ファイルがコピーされる先の、ターゲットディレクトリ(トップレベルのsite_dir)のOSパス。
use_directory_urls: bool = use_directory_urls インスタンス属性
ディレクトリURL('foo/')を使用するかしないか('foo.html')。
Falseの場合、Markdownファイルは同じ名前のHTMLファイルにマッピングされます(ファイル拡張子は.htmlに変更されます)。Trueの場合、Markdownファイルは、pathのファイル名を使用したディレクトリにネストされたい、HTMLインデックスファイル(index.html)にマッピングされます。Markdown以外のファイルは元のパスを保持します。
inclusion: InclusionLevel = inclusion クラス属性 インスタンス属性
ファイルが作成されたサイトから除外されるか否か。
name = cached_property(_get_stem) クラス属性 インスタンス属性
拡張子なしのファイル名を返します。
dest_uri = cached_property(_get_dest_path) クラス属性 インスタンス属性
ターゲットディレクトリに対する、ターゲットファイルの、純粋なパス(常に'/'で区切られる)。
url = cached_property(_get_url) クラス属性 インスタンス属性
ターゲットディレクトリに対するターゲットファイルのURIを文字列として返します。
abs_src_path: str | None キャッシュ プロパティ
ソースファイルの完全な具体的なパス。Windowsではバックスラッシュを使用します。
注意: このパスを使用してファイルを読み取らないでください。content_bytes/content_stringを優先してください。
abs_dest_path: str cached property
宛先ファイルの絶対具体的パス。Windows ではバックスラッシュを使用します。
content_bytes: bytes property writable
このファイルの内容をバイト文字列として取得します。
読み取れない場合は、実際のファイル（abs_src_path）に裏付けられている場合に例外が発生する場合があります。
セッターとして使用した場合、ファイルの内容を定義し、abs_src_path は未設定になります。
content_string: str property writable
このファイルの内容を文字列として取得します。UTF-8 エンコーディングが仮定されており、例外が発生する場合があります。
読み取れない場合は、実際のファイル（abs_src_path）に裏付けられている場合に例外が発生する場合もあります。
セッターとして使用した場合、ファイルの内容を定義し、abs_src_path は未設定になります。
generated(config: MkDocsConfig, src_uri: str, *, content: str | bytes | None = None, abs_src_path: str | None = None, inclusion: InclusionLevel = InclusionLevel.UNDEFINED) -> File classmethod
in-memory content または abs_src_path のファイルのいずれかに裏付けされた、仮想ファイルを作成します。
これは、src_uri にあるドキュメントディレクトリのファイルであると見なされます。
edit_uri() -> str | None
「編集」ボタンに使用するソースリポジトリに対する相対パス。
デフォルトは src_uri で、上書きできます。生成されたファイルの場合、これは None に設定する必要があります。
url_relative_to(other: File | str) -> str
他のファイルに対するファイルの相対 URL を返します。
copy_file(dirty: bool = False) -> None
ソースファイルを宛先にコピーし、親ディレクトリが存在することを確認します。
is_documentation_page() -> bool
ファイルがマークダウンページである場合に True を返します。
is_static_page() -> bool
ファイルが静的ページ（HTML、XML、JSON）である場合に True を返します。
is_media_file() -> bool
ファイルがドキュメンテーションページでも静的ページでもない場合に True を返します。
is_javascript() -> bool
ファイルが JavaScript ファイルである場合に True を返します。
is_css() -> bool
ファイルが CSS ファイルである場合に True を返します。
mkdocs.config.base.Config
ベース: UserDict
MkDocs の構成、プラグインの構成（およびサブ構成）オブジェクトのベースクラス。
サブクラス化され、ConfigOption を属性として定義する必要があります。例については、mkdocs/contrib/search/init.py と mkdocs/config/defaults.py を参照してください。
MkDocs 1.4 以前の動作は、現在 LegacyConfig が処理しています。
mkdocs.utils.templates.TemplateContext
ベース: TypedDict