MkDocs Awesome Pages Plugin 使用教程
1. 项目的目录结构及介绍
MkDocs Awesome Pages Plugin 是一个用于 MkDocs 的开源插件,旨在简化 MkDocs 项目的目录结构管理。以下是该项目的目录结构及其介绍:
mkdocs-awesome-pages-plugin/
├── docs/
│ ├── index.md
│ └── ...
├── mkdocs.yml
├── README.md
├── setup.py
└── awesome_pages/
├── __init__.py
└── plugin.py
docs/
:包含 MkDocs 文档的源文件。mkdocs.yml
:MkDocs 的主配置文件。README.md
:项目的介绍文档。setup.py
:用于安装项目的脚本。awesome_pages/
:插件的核心代码目录。__init__.py
:Python 包的初始化文件。plugin.py
:插件的主要实现代码。
2. 项目的启动文件介绍
MkDocs Awesome Pages Plugin 的启动文件是 setup.py
。该文件负责项目的安装和分发。以下是 setup.py
的主要内容:
from setuptools import setup, find_packages
setup(
name='mkdocs-awesome-pages-plugin',
version='2.6.0',
description='An MkDocs plugin that simplifies configuring page titles and their order',
long_description=open('README.md').read(),
long_description_content_type='text/markdown',
keywords='mkdocs',
url='https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin',
author='Lukas Geiter',
author_email='lukas@geiter.eu',
license='MIT',
python_requires='>=3.5',
install_requires=[
'mkdocs>=1.0.4'
],
classifiers=[
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'Intended Audience :: Information Technology',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
],
packages=find_packages(),
entry_points={
'mkdocs.plugins': [
'awesome-pages = awesome_pages.plugin:AwesomePagesPlugin'
]
}
)
3. 项目的配置文件介绍
MkDocs Awesome Pages Plugin 的配置文件是 mkdocs.yml
。该文件用于配置 MkDocs 项目的基本信息和插件设置。以下是一个示例配置:
site_name: 我的文档
nav:
- 首页: index.md
- 关于: about.md
plugins:
- search
- awesome-pages
site_name
:网站的名称。nav
:导航栏的配置。plugins
:启用的插件列表,包括search
和awesome-pages
。
通过在 plugins
部分添加 awesome-pages
,即可启用 MkDocs Awesome Pages Plugin。该插件会自动处理文档的目录结构和页面排序。