关于html5:利用mkdocs部署静态网页至GitHub-pages

2次阅读

共计 844 个字符,预计需要花费 3 分钟才能阅读完成。

Info:
官方网站:MkDocs
我的集体网站成绩:http://wcowin.work/

一、筹备工作

1. 下载 Github Desktop

2. 有一个 GitHub 账号​​​​​​​


二、Creating your site

参考教程:

网站制作 – Wcowin 的集体网站

与以往教程不同,我首先倡议先在 Github 创立一个名为你的名字 +github.io 的仓库

而后关上 github Desktop 克隆到本地

关上 Wcowin.github.io 目录进入终端运行:

mkdocs new mkdocs-site

呈现下图的几个文件

docs 文件下是当前网站的内容,mkdocs.yml 是配置文件(配置主题,目录,插件等)

你在这个目录下写的任何货色都能够通过 github Desktop 上传到 github 上

以 VScode 为例咱们关上具体看看外面的货色

(倡议先执行上面的代码增加一个 GitHub Workflow)

1.$ mkdir .github
2.$ cd .github
3.$ mkdir workflows
4.$ cd workflows
5.$ vim PublishMySite.yml

目录树状图:

$ tree -a
.
├── .github
│   ├── .DS_Store
│   └── workflows
│       └── PublishMySite.yml
├── docs
│   └── index.md
└── mkdocs.yml

三、配置欠缺

关上 mkdocs.yml

把以下的内容输出进去(最简略配置)

site_name: 网站名字
site_url: 
site_author: 你的名字
theme:
 name: material #主题 

具体 mkdocs.yml 配置见 Changing the colors – Material for MkDocs

下次我会具体谈谈这个问题


在下方终端运行能够在浏览器看到实时网站

mkdocs serve

这个网站就算是初步建好了

最初去 github Desktop 上传到 github

你的网站网址就是:​

https:// 你 github 的名字.github.io/

下次谈谈网站的具体配置

正文完
 0