python 一条命令建立一个静态网站
Python 利用mkdocs serve 命令行工具,在本地启动 MkDocs 服务,一条命令即可建立一个静态网站
1、项目配置mkdocs.yml文件
mkdocs.yml 是 MkDocs 项目的配置文件,它使用 YAML 格式定义了项目的结构、主题、插件和其他选项。下面是一个示例 mkdocs.yml 文件及其各个部分的说明:
yamlCopy Codesite_name: My Docs
nav:
- Home: index.md
- About: about.md
- Contact: contact.md
theme: material
- site_name: 这是你的文档站点的名称,将显示在导航栏或标题中。
- nav: 这是你文档站点的导航栏设置。每个导航栏项由键值对表示,键为显示在导航栏上的名称,值为对应页面的 Markdown 文件路径。在示例中,导航栏包含 "Home"、"About" 和 "Contact" 三个项,分别链接到 index.md、about.md 和 contact.md。
- theme: 这是文档站点使用的主题。MkDocs 提供了多个内置主题,比如示例中使用的 "material" 主题。你可以从 MkDocs 文档中查看可用的主题,并在此处指定你所选择的主题。
除了这些基本设置外,mkdocs.yml 还支持其他配置选项,例如:
- docs_dir: 指定文档源文件的目录,默认为 "docs"。
- site_dir: 指定生成的静态网站的目录,默认为 "site"。
- extra_css 和 extra_javascript: 可以用来添加自定义的 CSS 和 JavaScript 文件路径。
- plugins: 允许配置使用的插件。
在创建 MkDocs 项目后,你可以编辑 mkdocs.yml 来定义你自己的导航栏、修改主题设置、添加插件等。每次对 mkdocs.yml 进行更改后,运行 mkdocs serve 命令重新启动服务器即可应用新的配置。
2、终端启动mkdocs serve,但首先要安装mkdocs
pip install mkdocs
另外启动时可以指定 IP 和端口 mkdocs serve -a 192.168.0.100
3、输入网站地址,即可访问自己的网站了
4、下面是使用 mkdocs serve 启动本地服务器的一些详细步骤:
- 确认已经安装了 MkDocs:首先,确保已经安装了 MkDocs。如果没有,可以通过运行以下命令来安装:
- pip install mkdocs
- 创建 MkDocs 项目:如果还没有创建 MkDocs 项目,请参考 MkDocs 官方文档中的步骤。可以运行以下命令来生成一个新的 MkDocs 项目:
- mkdocs new my-project
cd my-project - 配置导航栏和其他选项:在配置文件 mkdocs.yml 中定义文档目录和导航栏等选项。可以打开该文件并进行编辑,根据需要进行修改。
- 启动 MkDocs 服务:当你完成了配置文件的设置以后,只需要在 MkDocs 项目的根目录下运行以下命令即可启动本地服务器:
- mkdocs serve
这将启动本地服务器,打开默认的浏览器窗口显示 MkDocs 文档站点。默认情况下,MkDocs 会使用 8000 端口来运行服务器。在浏览器中输入 http://localhost:8000/ 即可访问文档站点。
在运行 mkdocs serve 后,每次对文档进行更改之后,MkDocs 会自动重新构建站点,并在浏览器中刷新当前页面。因此,你可以专注于编写文档内容,而无需手动重新构建和部署文档站点。