如何建立github静态网站以及在本地搭建jekyll测试环境

方法一： 直接在某个项目里通过gh-pages分支创建这个项目的静态网站

• 每一个项目里都可以创建一个名为gh-pages的分支，gh-pages分支是一个特别的分支，独立于其他所有分支，它包含的是项目的静态网站的代码而不是项目代码。

• 这个分支可以通过github自带的github pages生成器自动创建，具体步骤为在项目主页右侧点击settings=》github pages，一步步生成即可。官方文档

方法二： 通过username.github.io项目创建静态网站

• 除了通过在项目里创建分支来创建静态网站，也可以直接创建一个名为username.github.io的项目(username是你的用户名)来存放静态网站。

• 只要我们把静态文件提交到此分支上，便可以通过 http://username.github.io 来访问我们的静态网站了

如何访问我们的静态网站

• 静态网站的域名为http://username.github.io，也可以自定义域名，查看文档

• 如果是方法一生成网站，我们可以通过http://username.github.io/项目名称 访问，如果是方法二生成的网站，我们通过http://username.github.io 直接访问。

如何编辑我们的网站

• 不管用何种方法生成网站，最终都仅仅是建立了一个可以存放静态文件且可以通过url访问到这些静态文件的github目录。如果要编辑我们的网站，只能通过手工编辑。

• 我们可以通过一些网站生成器生成静态网站，然后提交到网站目录，而github官方支持jekyll，我们可以把用jekyll标准书写的源代码提交到我们的目录，github会把他们自动编译成最终的静态网站。

创建jekyll静态网站

• jekyll官网： http://jekyllrb.com/

• 只要在github的静态网站项目里按照jekyll官方网站的格式建立我们的文件夹，书写我们的文件，然后再提交到github，github就可以自动把jekyll编译为静态网站：查看例子。本例 是在username.github.io项目里书写的jekyll，同理，我们也可以在某个项目的gh-pages分支里按照同样的格式来创建

• jekyll几个关键的文件和文件夹:

  • index.html: 网站首页

  • _layouts：模板布局页面

  • _posts: 文章页面，放置markdown格式的文章

搭建本地jekyll环境

参考官方文档： https://jekyllrb.com/docs/installation/windows/

注意：

1.rubyinstaller安装的时候需要选择默认配置，除了安装位置(默认是直接C盘建立一个根目录，改成program files好些)

2.第二步就是那个黑色弹窗，选择3，要等很久才能安装完，各种秘钥，到这个界面就差不多了：

==> 正在更新可信数据库… gpg: marginals needed: 3 completes needed: 1 trust model: pgp gpg: 深度：0 有效性： 1 已签名： 5 信任度：0-，0q，0n，0m，0f，1u gpg: 深度：1 有效性： 5 已签名： 7 信任度：0-，0q，0n，5m，0f，0u gpg: 深度：2 有效性： 4 已签名： 2 信任度：4-，0q，0n，0m，0f，0u gpg: 下次信任度数据库检查将于 2023-09-12 进行 gpg: 拉取‘alexey.pawlow@gmail.com’通过 WKD 时出现错误： Connection timed out gpg: error reading key: Connection timed out gpg: 正在更新 1 把密钥，从 hkps://keyserver.ubuntu.com gpg: 密钥 F40D263ECA25678A：“Alexey Pavlov (Alexpux) alexey.pawlow@gmail.com” 未改变 gpg: 处理的总数：1 gpg: 未改变：1

然后就可以不管这个窗口，开新窗口进入下一步。

3.第三步要打开新窗口执行gem install jekyll bundler，也是非常漫长，十多分钟，完成了就是这样：

A new release of RubyGems is available: 3.4.10 → 3.4.14! Run gem update --system 3.4.14 to update your installation.

C:\Users\LMJ>jekyll -v jekyll 4.3.1

最后进入git项目的根目录，运行jekyll serve ，然后访问http://127.0.0.1:4000/便能看到效果了

Gemfile 和Gemfile.lock可能导致版本问题报错，如果报错可以删了这两个文件再试。

本地测试好以后，把代码提交到github，github会自动生成静态网站。注意jekyll生成的_site文件夹不需要提交，这个是本地的静态网站文件夹

jekyll还有更多高级的用法，可以参考官方网站的源代码,里面包含了翻页，页面变量，页面数据等用法

以上内容和最初版本的jekyll安装方式有变动，增加了bundle部分。参考的https://idratherbewriting.com/documentation-theme-jekyll/mydoc_install_jekyll_on_windows.html#install-bundler。其实和npm的安装方式类似，需要把依赖装好，否则会报错找不到依赖模块。但是一旦一个项目bundle install了另一个项目就不需要了再bundle install了也是奇怪，可能模块默认是全局的。另外gem "webrick", "~> 1.7"这一行不要有可能也可以，没试过。