| creation date | 2024-02-20 21:45 |
|---|---|
| modification date | 星期二 20日 二月 2024 21:46:11 |
首先安装 git, 然后使用 git clone 此文档.
# 如果是使用 git clone git@github.com:RYefccd/republic.git
# 那么默认的 origin 就是 git@github.com:RYefccd/republic.git, 对这个进行重命名
# 如果用 https 协议 clone 的话, 那么重新设置 originssh 即可
git remote rename origin originssh
git remote add origin https://github.com/republicroad/republic.git
最后效果如下, 把仓库的 ssh 协议和https协议都配置完成.
$ git remote -v
origin https://github.com/republicroad/republic.git (fetch)
origin https://github.com/republicroad/republic.git (push)
originssh git@github.com:RYefccd/republic.git (fetch)
originssh git@github.com:RYefccd/republic.git (push)将下载的 mdbook 压缩包解压得到可执行文件 mdbook.exe, 把此文件放到系统的默认搜索目录下.
echo $PATH linux, mac
echo %PATH% windows
可以看到系统搜索目录.
比如 window11 可以放到用户AppData中的WindowsApps文件夹中.
C:\Users\RYefccd\AppData\Local\Microsoft\WindowsApps
可以用一下命令来把markdown文件构建成html页面并在网页打开.
mdbook.exe build republic -o
或者可以开启一个本地服务, 可以边修改文档边刷新:
mdbook.exe serve republic
其他配置可参考: Configuring Renderers
-
克隆仓库
git clone https://github.com/republicroad/republic.git
# 代码结构如下 wh@VM-16-16-ubuntu:~/workspace$ tree -L 2 . . ├── build_book.sh └── republic ├── attach ├── book.toml ├── Excalidraw ├── excalidrawlib ├── journal ├── LICENSE ├── obsidian_config ├── README.md └── src
-
mdbook 构建
mdbook build republic
wh@VM-16-16-ubuntu:~/workspace$ mdbook build republic
2024-02-04 16:55:57 [INFO] (mdbook::book): Book building has started
2024-02-04 16:55:57 [INFO] (mdbook::book): Running the html backendwh@VM-16-16-ubuntu:~/workspace$ tree -L 2 .
.
├── build_book.sh
└── republic
├── attach
├── book # 多了一个book文件夹
├── book.toml
├── Excalidraw
├── excalidrawlib
├── journal
├── LICENSE
├── obsidian_config
├── README.md
└── src- nginx 配置
location /book/ {
#root html;
root /home/wh/workspace/republic/;
index index.html index.htm;
}