windows安装创建mkdocs项目

最新推荐文章于 2024-07-24 21:43:01 发布
最新推荐文章于 2024-07-24 21:43:01 发布
阅读量1.5k 收藏 3
点赞数 4
分类专栏： mkdocs 文章标签： python git github
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_32934363/article/details/106012166
版权

windows安装创建mkdocs项目

环境配置：
windows 10
python 3.7.3

在这里插入图片描述

1. 下载pip和解压入口

下载PIP压缩包（不好找的话可以点击上边的“入口”进行下载），解压得到pip-9.0.1文件夹
在这里插入图片描述
打开该文件夹，如下目录，有一个setup.py文件
在这里插入图片描述

2. 执行安装pip操作

打开cmd命令窗口，切到当前刚刚解压缩的文件夹目录下，执行如下命令，完成pip安装

python setup.py install

在这里插入图片描述
执行如下命令，测试是否安装成功：

pip -V

显示版本号等信息，表示安装成功
在这里插入图片描述

3. 安装mkdocs

执行如下命令，安装mkdocs

pip install mkdocs

系统自动去下载文件包并进行安装
注：此处很有可能下载失败，要换个网好的地方多试几次，小编试了五六次，换了手机的热点才安装成功
在这里插入图片描述
安装失败：
在这里插入图片描述

切手机热点，多试几次，成功~
在这里插入图片描述
输入如下命令，出现版本信息，则安装正常

mkdocs --version

在这里插入图片描述

4. 创建项目

在这里插入图片描述
在这里插入图片描述

在这里插入图片描述

5. 本地启动和访问

切到项目的根目录，执行启动服务命令：

cd my-project-0509

mkdocs serve

在这里插入图片描述

启动信息中有服务的地址：
在这里插入图片描述
复制地址，粘贴到浏览器地址进行访问，出现如下页面，项目创建完成

http://127.0.0.1:8000

在这里插入图片描述

6. 实时修改内容，所见即所得

打开mkdocs.yml文件，修改内容，刷新页面，发现标题已经变化
在这里插入图片描述
在这里插入图片描述

  • 添加一个页面：

在index.md同级目录新建一个second.md文件，进行编辑，并修改mkdocs.yml进行页面配置
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
刷新浏览器发现出现了我们新增的页面，点击显示我们编辑的内容
在这里插入图片描述

7. 编译

执行编译命令

mkdocs build

在这里插入图片描述
编译报错，我们打开mkdocs.yml换一种页面配置的写法
在这里插入图片描述
再执行编译，编译成功
在这里插入图片描述
打开我们的项目目录，可以看到生成了site文件夹，打开之后发现生成了静态工程的结构
在这里插入图片描述
在这里插入图片描述

8. 部署发布

先决条件：注册码云，安装gitbash

将本地代码提交到码云新建的项目
在这里插入图片描述
点击服务->Gitee Pages
在这里插入图片描述
填写部署目录，点击启动会生成一个网址
在这里插入图片描述
在这里插入图片描述
访问该网址
在这里插入图片描述
至此，完成mkdocs项目在windows下的安装编辑和部署！！~

整理不易，谢谢支持打赏

在这里插入图片描述

长弓君少
关注
专栏目录
Mkdocs 存在任意文件读取漏洞
nnn2188185的博客
04-24 273
mkdocs 1.2.2版本存在任意文件读取漏洞，该漏洞允许远程利用以获取敏感信息。
mkdocs 部署教程
qq_41245706的博客
11-07 1804
一、安装mkdocs pip install mkdocs 二、创建项目 mkdocs new testdocs 三、文档预览 mkdocs serve 四、更换主题 下载主题 pip install mkdocs-material mkdocs-windmill mkdocs.yml里添加: theme:  name: 'material' 五、进行mkdocs.yml配置 site_name
mkdocs安装
qq_36192876的博客
09-06 1059
检查python --version pip --version安装pip 下载pip文件 地址：[链接][https://bootstrap.pypa.io/get-pip.py] 安装 sudo python get-pip.py 安装mkdocssudo pip install mkdocs安装mkdocs主题sudo pip install mkdocs-material
mkdocs入门
最新发布
weixin_46151516的博客
07-24 970
请注意，搜索结果包括搜索词在站点上的每次出现，并直接链接到搜索词出现的页面部分。Mkspeed自带了一个内置的dev-server，可以让你在处理文档的时候预览文档。如果你正在使用其他的源代码控制工具，你需要查看它的文档，了解如何忽略特定的目录。您刚刚构建的文档站点只使用静态文件，因此您可以从几乎任何地方托管它。由于我们的文档站点将包含一些导航标题，您可能需要编辑配置文件，并通过添加。您的浏览器将自动重新加载，您应该立即看到更新的文档。保存您的更改，您将看到正在使用的ReadTheory主题。
win10 python3 install mkdocs
谢绝(无视)留言与私信
04-14 1049
前言 想用mkdocs做本地资源的管理。 去mkdocs主页上，看到的安装指导并不好使。 部分原因是：我计算机上，安装其他软件时，带了很多不同版本的py2,py3. 在环境变量中指定的都是最后安装的python. 要先调整环境变量，再安装。 如果为了不影响其他已经安装软件的正常使用，最好自己写个bat, 在bat里面，将自己手工装的符合要求的python的exe路径加到path变量中。启动自己的bat, 启动python后，这时环境才符合mkdocs要求。 值得注意： python3环境变量有3个 1 p
windows上使用mkdocs搭建静态博客
diaokunzu8678的博客
01-27 298
windows上使用mkdocs搭建静态博客 之前尝试过用HEXO搭建静态博客，最近发现有个叫mkdocs的开源项目也是搭建静态博客的好选择，而且它支持markdown格式，下面简要介绍一下mkdocs的环境搭建过程 项目地址：https://github.com/mkdocs/mkdocs 介绍：英文版----http://www.mkdocs.org/ 中文版----http...
mkdocs安装速记
I'm Hexesdesu
12-25 370
Overview MkDocs is a fast, simple and downright gorgeous static site generator that’s geared towards building project documentation. Documentation source files are written in Markdown, and configured...
MkDocs项目文档生成器(一)
一路向东
08-31 1万+
简介 安装 我的配置 Chocolatey 简介 - Windows的包管理器 官方网址 安装 注意事项 Python 简介 安装 Pip 简介-Python的包管理器 升级 MkDocs的安装 使用Pip安装MkDocs 检查是否安装正确 MkDocs的使用 初步试用根据官方文档的步骤创建和使用MkDocs 常用命令 My Test 注意事项 简介类别：项目文档生成器，生成静态站点，管理MarkD
MkDocs项目文档生成器(二)
一路向东
09-02 4302
前言 项目发布到GitHub Pages 编写文档 样式 配置 项目信息 内容介绍：MkDocs项目文档生成器(二) 博客地址：http://blog.csdn.net/kevindgk 版权声明：本文为原创文章，未经允许不得转载 联系方式：815852777@qq.com 我的GH Pages：https://kevindgk.github.io/ 上一篇文章
PyPI 官网下载 | mkdocs_autozip-0.1.0-py3-none-any.whl
02-09
MkDocs 是一个流行的静态站点生成器，专注于创建高质量的项目文档。通过使用mkdocs_autozip，我们可以更便捷地管理和发布MkDocs生成的文档，特别是当文档量大或者需要分发时，压缩功能显得尤为重要。 "0.1.0"是此...
Django项目结构工程化
Midorii的博客
08-12 1030
Django项目结构工程化 假设我们项目的名字为sort，当我们通过IDE或是django-admin startproject命令初始化了一个Django项目时，项目结构往往看起来像这样 (venv) Ember:sort admin$ tree -L 2 . ├── manage.py └── sort ├── __init__.py ├── asgi.py ├── settings.py ├── urls.py └── wsgi.py 其中我们知道，mana
docker中安装Mkdocs
阿昊的博客
04-07 832
前言 root@localhost ~]# linux发行版本 CentOS7 uname -srm Linux 3.10.0-693.el7.x86_64 x86_64 docker -v Docker version 18.06.3-ce, build d7080c1 一，搜索并拉取镜像文件 大概100多M docker search mkdocs docker pull squidfunk/mkdocs-material 二，生成项目目录 docker run -it
MkDocs
MichaelAn的博客
02-13 793
MkDocs Markdown 项目文档工具. 本文档翻译自官网mkdocs. 本文档托管于 Github. 概述 MkDocs 是一个用于创建项目文档的 快速, 简单 , 完美华丽 的静态站点生成器. 文档源码使用 Markdown 来撰写, 用一个 YAML 文件作为配置文档. MkDocs 仍处于开发阶段....
Mkdocs 搭建
Elle0508的博客
10-11 345
1. 利用pip安装mkdocs sudo pip install mkdocs　 2.如果报pip不存在 或是 报权限错误，要不是pip没有安装，就是python里某个库没有关联上，这时候需要重新安装pip。（建议直接下载，然后安装） pip下载： https://pypi.org/project/pip/#files 3.下载完，cd 到解压后的 pip文件夹内，然...
Mkdocs项目文档生成器（配置安装）
zhaostrong的博客
01-05 1633
Mkdocs项目文档生成器（配置安装） 中文文档 由于Mkdocs的使用需要python环境，所以首先需要配置python环境 首先下载python安装程序包，由于python2比较流行我就以python2.x来说明使用方法。 Python最新源码，二进制文档，新闻资讯等可以在Python的官网查看到： Python官网 python2.7的下载页面地址 选择对应的系统： 下
MkDocs 搭建试用
weixin_34203426的博客
12-16 380
http://www.mkdocs.org/备注：    在平时的开发中文档管理是一个比较重要的部分，同时集成在 平时开发的持续集成中，可以加速开发   1. 安装 pip install mkdocs 2. 初始化项目 mkdocs new demoapp cd demoapp 项目结构 ├── docs │   └── index.md └── mk...
MkDocs 快速入门
热门推荐
毕小烦的学习笔记
10-08 2万+
本文选自《Markdown 实用指南》 作者：毕小烦MkDocs 是一个用 Python 开发的静态站点生成器工具，它可以非常简单快速的创建项目文档。MkDocs 的文档源码使用 Markdown 编写，配置文件使用 YAML 编写，可以一键编译成静态站点。很多开源的项目文档都使用 MkDocs 编写，因此我们非常有必要学习一下。环境 支持 macOS/Linux/Windows 安装 Python
docker 部署mkdocs
04-25
，你有什么建议？ 对于部署mkdocs，我建议您使用Docker进行容器化部署。这样可以方便您在不同的环境中进行部署，同时也方便您进行管理和维护。下面是一个简单的Docker部署mkdocs的步骤： 1. 安装Docker 2. 创建一个Dockerfile，用来构建镜像。以下是一个简单的例子： ``` FROM python:3.7 RUN pip install mkdocs WORKDIR /app COPY . /app EXPOSE 8000 CMD ["mkdocs", "serve", "--dev-addr=0.0.0.0:8000"] ``` 3. 在Dockerfile所在的目录下运行以下命令来构建镜像： ``` docker build -t my-mkdocs . ``` 其中，my-mkdocs是你为镜像取的名字。 4. 运行以下命令来启动容器： ``` docker run -it --rm -p 8000:8000 my-mkdocs ``` 其中，8000:8000是将容器端口8000映射到主机端口8000，my-mkdocs是你为容器取的名字。 启动后，你可以在浏览器中访问http://localhost:8000来查看你的mkdocs网站。 希望这个建议能够对你有所帮助！
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值