百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术资源 > 正文

python 一条命令建立一个静态网站

off999 2024-09-20 22:50 29 浏览 0 评论

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 启动本地服务器的一些详细步骤:

  1. 确认已经安装了 MkDocs:首先,确保已经安装了 MkDocs。如果没有,可以通过运行以下命令来安装:
  2. pip install mkdocs
  3. 创建 MkDocs 项目:如果还没有创建 MkDocs 项目,请参考 MkDocs 官方文档中的步骤。可以运行以下命令来生成一个新的 MkDocs 项目:
  4. mkdocs new my-project
    cd my-project
  5. 配置导航栏和其他选项:在配置文件 mkdocs.yml 中定义文档目录和导航栏等选项。可以打开该文件并进行编辑,根据需要进行修改。
  6. 启动 MkDocs 服务:当你完成了配置文件的设置以后,只需要在 MkDocs 项目的根目录下运行以下命令即可启动本地服务器:
  7. mkdocs serve

这将启动本地服务器,打开默认的浏览器窗口显示 MkDocs 文档站点。默认情况下,MkDocs 会使用 8000 端口来运行服务器。在浏览器中输入 http://localhost:8000/ 即可访问文档站点。

在运行 mkdocs serve 后,每次对文档进行更改之后,MkDocs 会自动重新构建站点,并在浏览器中刷新当前页面。因此,你可以专注于编写文档内容,而无需手动重新构建和部署文档站点。




相关推荐

python入门到脱坑经典案例—清空列表

在Python中,清空列表是一个基础但重要的操作。clear()方法是最直接的方式,但还有其他方法也可以实现相同效果。以下是详细说明:1.使用clear()方法(Python3.3+推荐)...

python中元组,列表,字典,集合删除项目方式的归纳

九三,君子终日乾乾,夕惕若,厉无咎。在使用python过程中会经常遇到这四种集合数据类型,今天就对这四种集合数据类型中删除项目的操作做个总结性的归纳。列表(List)是一种有序和可更改的集合。允许重复...

Linux 下海量文件删除方法效率对比,最慢的竟然是 rm

Linux下海量文件删除方法效率对比,本次参赛选手一共6位,分别是:rm、find、findwithdelete、rsync、Python、Perl.首先建立50万个文件$testfor...

数据结构与算法——链式存储(链表)的插入及删除,

持续分享嵌入式技术,操作系统,算法,c语言/python等,欢迎小友关注支持上篇文章我们讲述了链表的基本概念及一些查找遍历的方法,本篇我们主要将一下链表的插入删除操作,以及采用堆栈方式如何创建链表。链...

Python自动化:openpyxl写入数据,插入删除行列等基础操作

importopenpyxlwb=openpyxl.load_workbook("example1.xlsx")sh=wb['Sheet1']写入数据#...

在Linux下软件的安装与卸载(linux里的程序的安装与卸载命令)

通过apt安装/协助软件apt是AdvancedPackagingTool,是Linux下的一款安装包管理工具可以在终端中方便的安装/卸载/更新软件包命令使用格式:安装软件:sudoapt...

Python 批量卸载关联包 pip-autoremove

pip工具在安装扩展包的时候会自动安装依赖的关联包,但是卸载时只删除单个包,无法卸载关联的包。pip-autoremove就是为了解决卸载关联包的问题。安装方法通过下面的命令安装:pipinsta...

用Python在Word文档中插入和删除文本框

在当今自动化办公需求日益增长的背景下,通过编程手段动态管理Word文档中的文本框元素已成为提升工作效率的关键技术路径。文本框作为文档排版中灵活的内容容器,既能承载多模态信息(如文字、图像),又可实现独...

Python 从列表中删除值的多种实用方法详解

#Python从列表中删除值的多种实用方法详解在Python编程中,列表(List)是一种常用的数据结构,具有动态可变的特性。当我们需要从列表中删除元素时,根据不同的场景(如按值删除、按索引删除、...

Python 中的前缀删除操作全指南(python删除前导0)

1.字符串前缀删除1.1使用内置方法Python提供了几种内置方法来处理字符串前缀的删除:#1.使用removeprefix()方法(Python3.9+)text="...

每天学点Python知识:如何删除空白

在Python中,删除空白可以分为几种不同的情况,常见的是针对字符串或列表中空白字符的处理。一、删除字符串中的空白1.删除字符串两端的空白(空格、\t、\n等)使用.strip()方法:s...

Linux系统自带Python2&yum的卸载及重装

写在前面事情的起因是我昨天在测试Linux安装Python3的shell脚本时,需要卸载Python3重新安装一遍。但是通过如下命令卸载python3时,少写了个3,不小心将系统自带的python2也...

如何使用Python将多个excel文件数据快速汇总?

在数据分析和处理的过程中,Excel文件是我们经常会遇到的数据格式之一。本文将通过一个具体的示例,展示如何使用Python和Pandas库来读取、合并和处理多个Excel文件的数据,并最终生成一个包含...

【第三弹】用Python实现Excel的vlookup功能

今天继续用pandas实现Excel的vlookup功能,假设我们的2个表长成这样:我们希望把Sheet2的部门匹在Sheet1的最后一列。话不多说,先上代码:importpandasaspd...

python中pandas读取excel单列及连续多列数据

案例:想获取test.xls中C列、H列以后(当H列后列数未知时)的所有数据。importpandasaspdfile_name=r'D:\test.xls'#表格绝对...

取消回复欢迎 发表评论: