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

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

off999 2024-09-20 22:50 16 浏览 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 库:datetime 模块全攻略,时间操作太丝滑!

在日常开发中,时间处理是绕不开的一块,比如:生成时间戳比较两个时间差转换为可读格式接口传参/前端展示/日志记录今天我们就用一个案例+代码+思维导图,带你完全搞定datetime模块的用法!...

字节跳动!2023全套Python入门笔记合集

学完python出来,已经工作3年啦,最近有很多小伙伴问我,学习python有什么用其实能做的有很多可以提高工作效率增强逻辑思维还能做爬虫网站数据分析等等!!最近也是整理了很多适合零基...

为什么你觉得Matplotlib用起来困难?因为你还没看过这个思维导图

前言Matplotlib是一个流行的Python库,可以很容易地用于创建数据可视化。然而,设置数据、参数、图形和绘图在每次执行新项目时都可能变得非常混乱和繁琐。而且由于应用不同,我们不知道选择哪一个图...

Python新手必看!30分钟搞懂break/continue(附5个实战案例)

一、跳转语句的使命当程序需要提前结束循环或跳过特定迭代时,break和continue就是你的代码急刹按钮和跳步指令。就像在迷宫探险中:break=发现出口立即离开continue=跳过陷阱继续前进二...

刘心向学(24)Python中的数据类(python中5种简单的数据类型)

分享兴趣,传播快乐,增长见闻,留下美好!亲爱的您,这里是LearningYard新学苑。今天小编为大家带来文章“刘心向学(24)Python中的数据类”欢迎您的访问。Shareinterest,...

刘心向学(25)Python中的虚拟环境(python虚拟环境安装和配置)

分享兴趣,传播快乐,增长见闻,留下美好!亲爱的您,这里是LearningYard新学苑。今天小编为大家带来文章“刘心向学(25)Python中的虚拟环境”欢迎您的访问。Shareinte...

栋察宇宙(八):Python 中的 wordcloud 库学习介绍

分享乐趣,传播快乐,增长见识,留下美好。亲爱的您,这里是LearingYard学苑!今天小编为大家带来“Python中的wordcloud库学习介绍”欢迎您的访问!Sharethefun,...

AI在用|ChatGPT、Claude 3助攻,1分钟GET高颜值思维导图

机器之能报道编辑:Cardinal以大模型、AIGC为代表的人工智能浪潮已经在悄然改变着我们生活及工作方式,但绝大部分人依然不知道该如何使用。因此,我们推出了「AI在用」专栏,通过直观、有趣且简洁的人...

使用DeepSeek + Python开发AI思维导图应用,非常强!

最近基于Deepseek+PythonWeb技术开发了一个AI对话自动生成思维导图的应用,用来展示下如何基于低门槛的Python相关技术栈,高效结合deepseek实现从应用场景到实际应用的快速落地...

10幅思维导图告诉你 - Python 核心知识体系

首先,按顺序依次展示了以下内容的一系列思维导图:基础知识,数据类型(数字,字符串,列表,元组,字典,集合),条件&循环,文件对象,错误&异常,函数,模块,面向对象编程;接着,结合这些思维导图主要参考的...

Python基础核心思维导图,让你轻松入门

Python基础核心思维导图【高清图文末获取】学习路线图就给大家看到这里了,需要的小伙伴下方获取获取方式看下方图片...

Python基础核心思维导图,学会事半功倍

Python基础核心思维导图【高清图文末获取】学习路线图就给大家看到这里了,需要的小伙伴下方获取获取方式看下方图片...

硬核!288页Python核心知识笔记(附思维导图,建议收藏)

今天就给大家分享一份288页Python核心知识笔记,相较于部分朋友乱糟糟的笔记,这份笔记更够系统地总结相关知识,巩固Python知识体系。文末获取完整版PDF该笔记学习思维导图:目录内容展示【领取方...

Python学习知识思维导图(高效学习)

Python学习知识思维导图python基础知识python数据类型条件循环列表元组字典集合字符串序列函数面向对象编程模块错误异常文件对象#python##python自学##编程#...

别找了!288页Python核心知识笔记(附思维导图,建议收藏)

今天就给大家分享一份288页Python核心知识笔记,相较于部分朋友乱糟糟的笔记,这份笔记更够系统地总结相关知识,巩固Python知识体系。文末获取完整版PDF该笔记学习思维导图:目录内容展示【领取方...

取消回复欢迎 发表评论: