Tài liệu tham khảo
Ghi chú
Điểm vào chính của API là thông qua Sự kiện được nhận bởi plugin. Mô tả của các sự kiện này liên kết trở lại trang này.
mkdocs.structure.files.Files
Một bộ sưu tập các đối tượng File .
src_paths: dict[str, File] property
Không còn được sử dụng nữa, thay vào đó là src_uris.
src_uris: Mapping[str, File] property
Một ánh xạ chứa mọi tệp, với các khóa là src_uri.
__iter__() -> Iterator[File]
Lặp lại các tập tin bên trong.
__len__() -> int
Số lượng tập tin bên trong.
__contains__(path: str) -> bool
Không còn được sử dụng nữa, thay vào đó là get_file_from_path(path) is not None.
get_file_from_path(path: str) -> File | None
Trả về một thể hiện File với File.src_uri bằng với path.
append(file: File) -> None
Thêm tệp vào bộ sưu tập Tệp.
remove(file: File) -> None
Xóa tệp khỏi bộ sưu tập Tệp.
copy_static_files(dirty: bool = False, *, inclusion: Callable[[InclusionLevel], bool] = InclusionLevel.is_included) -> None
Sao chép các tập tin tĩnh từ nguồn tới đích.
documentation_pages(*, inclusion: Callable[[InclusionLevel], bool] = InclusionLevel.is_included) -> Sequence[File]
Trả về phần lặp lại của tất cả các đối tượng tệp trang Markdown.
static_pages() -> Sequence[File]
Trả về phần lặp lại của tất cả các đối t ượng tệp trang tĩnh.
media_files() -> Sequence[File]
Trả về phần lặp lại của tất cả các đối tượng tệp không phải là tài liệu hoặc trang tĩnh.
javascript_files() -> Sequence[File]
Trả về phần lặp lại của tất cả các đối tượng tệp javascript.
css_files() -> Sequence[File]
Trả về phần lặp lại của tất cả các đối tượng tệp CSS.
add_files_from_theme(env: jinja2.Environment, config: MkDocsConfig) -> None
Truy xuất các tệp tĩnh từ môi trường Jinja và thêm vào bộ sưu tập.
mkdocs.structure.files.File
Một đối tượng tệp MkDocs.
Nó biểu thị cách nội dung của một tệp sẽ được đưa vào trang đích.
Một tập tin luôn có phần abs_dest_path(được lấy bằng cách nối dest_dirvà dest_path), trong đó dest_dirđược hiểu là thư mục trang web .
content_bytes/ content_string(mới trong MkDocs 1.6) luôn có thể được sử dụng để lấy nội dung của tệp. Nhưng nó có thể được hỗ trợ bởi một trong hai nguồn:
-
Tệp nguồn vật lý tại
abs_src_path(theo mặc định được lấy bằng cách nốisrc_dirvàsrc_uri).src_dirđược hiểu là thư mục docs .Sau đó
content_bytes/content_stringsẽ đọc tệp tạiabs_src_path.src_dirnên được điền vào cho các tập tin thực và nên được điềnNonevào cho các tập tin được tạo. -
Kể từ MkDocs 1.6, một tập tin có thể được lưu trữ trong bộ nhớ -
content_string/content_bytes.Sau đó
src_dirvàabs_src_pathsẽ vẫn giữ nguyênNone.content_bytes/content_stringcần được ghi vào hoặc điền thông quacontentđối số trong hàm tạo.Nhưng
src_urivẫn được điền cho các tệp như vậy! Tệp ảo giả vờ như thể nó bắt nguồn từ đường dẫn đó trongdocsthư mục và các giá trị khác được suy ra.
Đối với các tập tin tĩnh, tập tin chỉ được sao chép đến đích và dest_uribằng src_uri.
Đối với các tệp Markdown (được xác định bởi phần mở rộng tệp trong src_uri), nội dung đích sẽ là nội dung được hiển thị và dest_urisẽ có .htmlphần mở rộng và một số chuyển đổi bổ sung cho đường dẫn dựa trên use_directory_urls.
src_uri: str
Đường dẫn thuần túy (luôn được phân tách bằng dấu '/') của tệp nguồn so với thư mục nguồn.
generated_by: str | None = None
Nếu không phải là Không, nghĩa là có một plugin đã tạo tệp này ngay lập tức.
Giá trị là tên điểm vào của plugin và có thể được sử dụng để tìm plugin theo khóa trong PluginCollection.
dest_path: str property writable
Giống như dest_uri(và đồng bộ với nó) nhưng sẽ sử dụng dấu gạch chéo ngược trên Windows. Không khuyến khích.
src_path: str = path property writable
Giống như src_uri(và đồng bộ với nó) nhưng sẽ sử dụng dấu gạch chéo ngược trên Windows. Không khuyến khích.
src_dir: str | None = src_dir
Đường dẫn hệ điều hành của thư mục cấp cao nhất mà tệp nguồn bắt nguồn từ đó.
Được cho là docs_dir ; không được điền thông tin cho các tệp được tạo.
dest_dir: str = dest_dir
Đường dẫn hệ điều hành của thư mục đích (site_dir cấp cao nhất) mà tệp sẽ được sao chép vào.
use_directory_urls: bool = use_directory_urls
Có nên sử dụng URL thư mục ('foo/') hay không ('foo.html').
Nếu False, tệp Markdown được ánh xạ tới tệp HTML có cùng tên (phần mở rộng tệp được đổi thành .html). Nếu Đúng, tệp Markdown được ánh xạ tới tệp chỉ mục HTML ( index.html) được lồng trong thư mục bằng cách sử dụng "tên" của tệp trong path. Các tệp không phải Markdown vẫn giữ nguyên đường dẫn gốc của chúng.
inclusion: InclusionLevel = inclusion
Liệu tập tin có bị loại khỏi trang web đã xây dựng hay không.
name = cached_property(_get_stem)
Trả về tên tệp không có phần mở rộng.
dest_uri = cached_property(_get_dest_path)
Đường dẫn thuần túy (luôn được phân tách bằng dấu '/') của tệp đích so với thư mục đích.
url = cached_property(_get_url)
URI của tệp đích liên quan đến thư mục đích dưới dạng chuỗi.
abs_src_path: str | None cached property
Đường dẫn cụ thể tuyệt đối của tệp nguồn. Sẽ sử dụng dấu gạch chéo ngược trên Windows.
Lưu ý: không sử dụng đường dẫn này để đọc tệp, hãy sử dụng content_bytes/ content_string.
abs_dest_path: str cached property
Đường dẫn cụ thể tuyệt đối của tệp đích. Sẽ sử dụng dấu gạch chéo ngược trên Windows.
content_bytes: bytes property writable
Lấy nội dung của tệp này dưới dạng chuỗi byte.
Có thể tăng nếu được hỗ trợ bởi một tệp thực ( abs_src_path) nếu không thể đọc được.
Nếu được sử dụng như một lệnh thiết lập, nó sẽ xác định nội dung của tệp và abs_src_pathtrở thành lệnh không thiết lập.
content_string: str property writable
Lấy nội dung của tệp này dưới dạng chuỗi. Giả sử mã hóa UTF-8, có thể tăng.
Cũng có thể tăng nếu được hỗ trợ bởi một tệp thực ( abs_src_path) nếu không thể đọc được.
Nếu được sử dụng như một lệnh thiết lập, nó sẽ xác định nội dung của tệp và abs_src_pathtrở thành lệnh không thiết lập.
generated(config: MkDocsConfig, src_uri: str, *, content: str | bytes | None = None, abs_src_path: str | None = None, inclusion: InclusionLevel = InclusionLevel.UNDEFINED) -> File classmethod
Tạo một tệp ảo, được hỗ trợ bởi bộ nhớ trong contenthoặc bởi một tệp tại abs_src_path.
Nó sẽ giả vờ là một tập tin trong thư mục docs tại src_uri.
edit_uri() -> str | None
Đường dẫn tương đối đến kho lưu trữ nguồn để sử dụng cho nút "chỉnh sửa".
Mặc định là src_urivà có thể ghi đè. Đối với các tệp được tạo, nên đặt thành None.
url_relative_to(other: File | str) -> str
Trả về url cho tệp liên quan đến tệp khác.
copy_file(dirty: bool = False) -> None
Sao chép tệp nguồn vào đích, đảm bảo thư mục cha tồn tại.
is_documentation_page() -> bool
Trả về True nếu tệp là trang Markdown.
is_static_page() -> bool
Trả về True nếu tệp là trang tĩnh (HTML, XML, JSON).
is_media_file() -> bool
Trả về True nếu tệp không phải là tài liệu hoặc trang tĩnh.
is_javascript() -> bool
Trả về True nếu tệp là tệp JavaScript.
is_css() -> bool
Trả về True nếu tệp là tệp CSS.
mkdocs.config.base.Config
Các căn cứ:UserDict
Lớp cơ sở cho các đối tượng cấu hình MkDocs, cấu hình plugin (và cấu hình phụ).
Nó phải được phân lớp và có ConfigOptions được định nghĩa là thuộc tính. Ví dụ, hãy xem mkdocs/contrib/search/ init .py và mkdocs/config/defaults.py.
Hành vi như trước MkDocs 1.4 hiện được xử lý bởi LegacyConfig.
__new__(*args, **kwargs) -> Config
Khả năng tương thích: cho phép tham chiếu đến LegacyConfig(...)hàm tạo là Config(...).
set_defaults() -> None
Thiết lập cấu hình cơ sở bằng cách duyệt qua từng trình xác thực và lấy cấu hình mặc định nếu có.
load_dict(patch: dict) -> None
Tải các tùy chọn cấu hình từ một từ điển.
load_file(config_file: IO) -> None
Tải các tùy chọn cấu hình từ mô tả tệp mở của tệp YAML.
mkdocs.utils.templates.TemplateContext
Các căn cứ:TypedDict
nav: Navigation
pages: Sequence[File]
base_url: str
mkdocs_version: str
build_date_utc: datetime.datetime
config: MkDocsConfig
page: Page | None
mkdocs.livereload.LiveReloadServer
Các căn cứ: ThreadingMixIn,WSGIServer
watch(path: str, func: None = None, *, recursive: bool = True) -> None
Thêm 'đường dẫn' vào các đường dẫn được theo dõi, gọi hàm và tải lại khi có bất kỳ tệp nào thay đổi bên dưới hàm đó.
unwatch(path: str) -> None
Dừng theo dõi các thay đổi tệp cho đường dẫn. Nâng lên nếu không có watchlệnh gọi tương ứng.