使用Jekyll+GithubPages写Notes

介绍

Jekyll是一个静态网站生成器，能将文本标记语言(例如markdown)生成html文件，从而能在站点上进行部署。

Jekyll安装

先决条件：

• Ruby version 2.5.0 或更高
• RubyGems
• GCC and Make

这些在网上简单搜索即可，使用查看版本号的命令可以看看是否安装完毕
参考教程

Just-the-docs 主题安装

无意间看到CS162的HW的文档风格是这样的：

顿时感觉这个主题简洁美观，于是决定使用这个主题

安装教程

本地启动

运行

bundle exec jekyll serve

可以在本地打开localhost:4000 这个端口，查看网站情况

部署到GitHub Pages

起初我以为每个账户只能拥有一个Github Pages，其实不然，针对username的域名的确只能有一个，但是project没有限制。

步骤：

1. 去Github 新建一个仓库，名字随意，与是否github.io结尾无关
2. 将本地文件目录下的全部文件上传至远程仓库，这里我不清楚只传一个总的文件是否可以，我是把文件本身作为一个本地仓库，然后上传的话就把目录下的所有文件上传：
   
3. 将本地Jekyll的_config.yml文件进行修改：
   
   还需要修改：

   domain: my-site.github.io       # if you want to force HTTPS, specify the domain without the http at the start, e.g. example.com
   url: https://my-site.github.io  # the base hostname and protocol for your site, e.g. http://example.com
   baseurl: /REPOSITORY-NAME/      # place folder name if the site is served in a subfolder

   我最开始没有注释掉原来的theme，导致Action一直部署失败：
   

其实最重要的是，在just-the-docs的文档第一句就已经说明白了：

可以对Action进行查看，里面有报错提醒，更多参考

最后生成域名：

补充： 如果想要生成数学公式，可参考just-the-docs test

大功告成！