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

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

off999 2024-09-20 22:50 41 浏览 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 会自动重新构建站点,并在浏览器中刷新当前页面。因此,你可以专注于编写文档内容,而无需手动重新构建和部署文档站点。




相关推荐

apisix动态修改路由的原理_动态路由协议rip的配置

ApacheAPISIX能够实现动态修改路由(DynamicRouting)的核心原理,是它将传统的静态Nginx配置彻底解耦,通过中心化配置存储(如etcd)+OpenRest...

使用 Docker 部署 OpenResty Manager 搭建可视化反向代理系统

在之前的文章中,xiaoz推荐过可视化Nginx反向代理工具NginxProxyManager,最近xiaoz还发现一款功能更加强大,界面更加漂亮的OpenRestyManager,完全可以替代...

OpenResty 入门指南:从基础到动态路由实战

一、引言1.1OpenResty简介OpenResty是一款基于Nginx的高性能Web平台,通过集成Lua脚本和丰富的模块,将Nginx从静态反向代理转变为可动态编程的应用平台...

OpenResty 的 Lua 动态能力_openresty 动态upstream

OpenResty的Lua动态能力是其最核心的优势,它将LuaJIT嵌入到Nginx的每一个请求处理阶段,使得开发者可以用Lua脚本动态控制请求的生命周期,而无需重新编译或rel...

LVS和Nginx_lvs和nginx的区别

LVS(LinuxVirtualServer)和Nginx都是常用的负载均衡解决方案,广泛应用于大型网站和分布式系统中,以提高系统的性能、可用性和可扩展性。一、基本概念1.LVS(Linux...

外网连接到内网服务器需要端口映射吗,如何操作?

外网访问内网服务器通常需要端口映射(或内网穿透),这是跨越公网与私网边界的关键技术。操作方式取决于网络环境,以下分场景详解。一、端口映射的核心原理内网服务器位于私有IP地址段(如192.168.x.x...

Nginx如何解决C10K问题(1万个并发连接)?

关注△mikechen△,十余年BAT架构经验倾囊相授!大家好,我是mikechen。Nginx是大型架构的必备中间件,下面我就全面来详解NginxC10k问题@mikechen文章来源:mikec...

炸场!Spring Boot 9 大内置过滤器实战手册:从坑到神

炸场!SpringBoot9大内置过滤器实战手册:从坑到神在Java开发圈摸爬滚打十年,见过太多团队重复造轮子——明明SpringBoot自带的过滤器就能解决的问题,偏偏要手写几十...

WordPress和Typecho xmlrpc漏洞_wordpress主题漏洞

一般大家都关注WordPress,毕竟用户量巨大,而国内的Typecho作为轻量级的博客系统就关注的人并不多。Typecho有很多借鉴WordPress的,包括兼容的xmlrpc接口,而WordPre...

Linux Shell 入门教程(六):重定向、管道与命令替换

在前几篇中,我们学习了函数、流程控制等Shell编程的基础内容。现在我们来探索更高级的功能:如何控制数据流向、将命令链接在一起、让命令间通信变得可能。一、输入输出重定向(>、>>...

Nginx的location匹配规则,90%的人都没完全搞懂,一张图让你秒懂

刚配完nginx网站就崩了?运维和开发都头疼的location匹配规则优先级,弄错顺序直接导致500错误。核心在于nginx处理location时顺序严格:先精确匹配=,然后前缀匹配^~,接着按顺序正...

liunx服务器查看故障命令有那些?_linux查看服务器性能命令

在Linux服务器上排查故障时,需要使用一系列命令来检查系统状态、日志文件、资源利用情况以及网络状况。以下是常用的故障排查命令,按照不同场景分类说明。1.系统资源相关命令1.1查看CPU使...

服务器被入侵的常见迹象有哪些?_服务器入侵可以被完全操纵吗

服务器被入侵可能会导致数据泄露、服务异常或完全失控。及时发现入侵迹象能够帮助你尽早采取措施,减少损失。以下是服务器被入侵的常见迹象以及相关的分析与处理建议。1.服务器被入侵的常见迹象1.1系统性能...

前端错误可观测最佳实践_前端错误提示

场景解析对于前端项目,生产环境的代码通常经过压缩、混淆和打包处理,当代码在运行过程中产生错误时,通常难以还原原始代码从而定位问题,对于深度混淆尤其如此,因此Mozilla自2011年开始发起并...

8个能让你的Kubernetes集群“瞬间崩溃”的配置错误

错误一:livenessProbe探针“自杀式”配置——30秒内让Pod重启20次现象:Pod状态在Running→Terminating→CrashLoopBackOff之间循环,重启间隔仅...

取消回复欢迎 发表评论: