mkdocs 建站

2024年05月03日 921 字大概 4 分钟

关于mkdocs的一些笔记

部署站点

当你尽心尽力地输出文档后，你不希望这些内容只能自己在本地看吧，你还是希望将这些文档部署到服务器上，让其他人也能看。本小节就讲解如何部署文档到服务器上。

首先来认识一个命令:

1 2	`mkdocs build`

这个命令会在learn-mkdocs目录下生成一个目录site，这个目录中包含了静态站点的页面内容。
我们可以在GitHub中创建一个仓库，名为mymkdocs。
然后在learn-mkdocs下打开git，并将当前目录设置为一个仓库，然后与GitHub新创建的仓库mymkdocs连接：

1 2	`git init git remote add origin https://github.com/xxxxx/mymkdocs.git`

然后在相应目录下（整个想要部署到站点的原项目的目录）打开终端，输入以下命令：

1 2	`mkdocs gh-deploy`

浏览器访问此命令后产生的链接即可。

some problrms

在操作过程中菜菜遇到了以下问题

1 . unable to access ‘https://github.com/xxxxx/xxxxx‘: Failed to connect to github.com port 443 after 2087 ms: Couldn’t connect to server

how to solve：

分析：Git 所设端口与系统代理不一致，需重新设置。方法：
打开设置，网络，查找代理，记录下当前系统代理的 IP 地址和端口号。
并将git修改为自己的IP和端口号：

for example

1 2	`git config --global http.proxy http://127.0.0.1:7890(注意是自己的IP与端口号) git config --global https.proxy http://127.0.0.1:7890`

2 . could not read Username for ‘https://github.com‘: No such file or directory

how to solve:

分析：菜菜自己是因为SSH Key 已经过期需要重新建一个。方法：
右击git bash 命令行输入：

1 2	`$ git config --global user.name “li” //配置用户名 $ git config --global user.email “123@163.com” //配置用户邮箱地址`

生成公钥和私钥，命令行输入:

1	`ssh-keygen -t rsa -C "123@163.com"`

回车三次后，命令行输入：

1 2	`cd ~/.ssh cat id_rsa.pub ——查看公钥（将公钥复制保留，一会用到）`

再打开github你自己的仓库，settings中的deploy keys
将你刚刚生成的密钥复制粘贴，添加密钥即可。然后再重复部署站点的步骤就没有问题咯。

3 .若在vscode上无法打开预览
先将vscode关闭
然后打开终端输入以下命令

1	`code --no--sandbox`

4.fatal: unable to access ‘https://github.com/lakerswillwin/learning/‘: Failure when receiving data from the peer

因为今天我发现自己的GitHub怎么也打不开，所以我先在C：/windows：/system32/etc 中找到host文件，将GitHub.com和github.global.ssl.fastly.net的ip地址写入文件中（需要以管理员身份运行），然后打开终端 ipconfig /flushdns 进行刷新DNS缓存。再将代码托管时，我用 git config –global –unset https.proxy 将git代理取消，因为本地已经存在SSR，然后进行仓库的拷贝即可。

常见的数学公式

行内公式：在需要插入数学公式的地方用两个美元符号包裹公式内容。例如，这是一个行内公式的使用示例：$e^{i\pi}+1=0$
块级公式：在单独的行用两对美元符号包裹公式内容。例如，这是块级公式的使用方式：
plaintext
$$
\begin{aligned}
\dot{x} & = \sigma(y-x) \
\dot{y} & = \rho x - y - xz \
\dot{z} & = -\beta z + xy
\end{aligned}
$$
常用数学公式
Greek letters ：例如 $\alpha$, $\beta, \gamma, \Gamma, \pi, \Pi, \phi, \varphi, \mu, …$
上标和下标 : $x^{2}, x_{2}, x_{i}^{2}$
分数 : $\frac{a}{b}$
开方 : $\sqrt{a}, \sqrt[n]{a}$
求和 : $\sum_{i=1}^{n}$
积分 : $\int_{a}^{b}$
复数 : $\bar{z}=2-3i$

本文总阅读量次