API reference

Note

The main entry point to the API is through Events that are received by plugins. These events' descriptions link back to this page.

mkdocs.structure.files.Files

A collection of File objects.

__iter__() -> Iterator[File]

Iterate over the files within.

__len__() -> int

The number of files within.

__contains__(path: str) -> bool

Whether the file with this src_uri is in the collection.

src_paths() -> Dict[str, File] property

Soft-deprecated, prefer src_uris.

src_uris() -> Dict[str, File] property

A mapping containing every file, with the keys being their src_uri.

get_file_from_path(path: str) -> Optional[File]

Return a File instance with File.src_uri equal to path.

append(file: File) -> None

Append file to Files collection.

remove(file: File) -> None

Remove file from Files collection.

copy_static_files(dirty: bool = False) -> None

Copy static files from source to destination.

documentation_pages() -> Sequence[File]

Return iterable of all Markdown page file objects.

static_pages() -> Sequence[File]

Return iterable of all static page file objects.

media_files() -> Sequence[File]

Return iterable of all file objects which are not documentation or static pages.

javascript_files() -> Sequence[File]

Return iterable of all javascript file objects.

css_files() -> Sequence[File]

Return iterable of all CSS file objects.

add_files_from_theme(env: jinja2.Environment, config: MkDocsConfig) -> None

Retrieve static files from Jinja environment and add to collection.

mkdocs.structure.files.File

A MkDocs File object.

Points to the source and destination locations of a file.

The path argument must be a path that exists relative to src_dir.

The src_dir and dest_dir must be absolute paths on the local file system.

The use_directory_urls argument controls how destination paths are generated. If False, a Markdown file is mapped to an HTML file of the same name (the file extension is changed to .html). If True, a Markdown file is mapped to an HTML index file (index.html) nested in a directory using the "name" of the file in path. The use_directory_urls argument has no effect on non-Markdown files.

File objects have the following properties, which are Unicode strings:

src_uri: str class-attribute

The pure path (always '/'-separated) of the source file relative to the source directory.

dest_path() -> str property writable

Same as dest_uri (and synchronized with it) but will use backslashes on Windows. Discouraged.

url_relative_to(other: File) -> str

Return url for file relative to other file.

copy_file(dirty: bool = False) -> None

Copy source file to destination, ensuring parent directories exist.

is_documentation_page() -> bool

Return True if file is a Markdown page.

is_static_page() -> bool

Return True if file is a static page (HTML, XML, JSON).

is_media_file() -> bool

Return True if file is not a documentation or static page.

is_javascript() -> bool

Return True if file is a JavaScript file.

is_css() -> bool

Return True if file is a CSS file.

mkdocs.config.base.Config

Bases: UserDict

Base class for MkDocs configuration, plugin configuration (and sub-configuration) objects.

It should be subclassed and have ConfigOptions defined as attributes. For examples, see mkdocs/contrib/search/init.py and mkdocs/config/defaults.py.

Behavior as it was prior to MkDocs 1.4 is now handled by LegacyConfig.

__new__(*args, **kwargs) -> Config

Compatibility: allow referring to LegacyConfig(...) constructor as Config(...).

set_defaults() -> None

Set the base config by going through each validator and getting the default if it has one.

load_dict(patch: Optional[dict]) -> None

Load config options from a dictionary.

load_file(config_file: IO) -> None

Load config options from the open file descriptor of a YAML file.

mkdocs.livereload.LiveReloadServer

Bases: socketserver.ThreadingMixIn, wsgiref.simple_server.WSGIServer

watch(path: str, func: Optional[Callable[[], None]] = None, recursive: bool = True) -> None

Add the 'path' to watched paths, call the function and reload when any file changes under it.

unwatch(path: str) -> None

Stop watching file changes for path. Raises if there was no corresponding watch call.