Jekyll + Github Pages快速使用

目录

• 配置环境
• 上传sdk文档
• 侧边导航栏
• 代码块一键复制
• 首页修改
• 主题官方文档

配置环境

1. 安装Ruby和Jekyll ， Windows安装参考此链接 ，mac参考此链接。

2. 从 我的GitHub fork jekyll-TeXt-theme 项目到你的仓库，然后将其重命名为 USERNAME.github.io — 这里的 USERNAME 是你的 GitHub 用户名。然后打开https://USERNAME.github.io访问博客。

3. 将项目clone到本地。

4. 安装 Ruby 依赖包，在本地项目所在目录输入如下命令：

   bundle install --path vendor/bundle
   

5. Jekyll 集成了一个开发用的服务器，可以让你使用浏览器在本地进行预览。

   在本地的项目下通过 bundle exec jekyll serve 命令启动开发服务器，然后就可以访问 http://localhost:4000/ 预览网站了。

上传sdk文档

1. 在_config.yml 文件末尾添加以下代码

collections:
  python-sdk:
    output: true
  [sdk语言]-sdk:
    output: true

2. 以python-sdk为例，在collections 文件夹下，添加_python-sdk文件夹（注意别忘记前面的_) ，将写好的markdown文件放在这个文件夹下面。访问 http://localhost:4000/python-sdk/文件名.html 预览网页效果。
3. 如果无法找到使用中文路径的文件：jekyll 使用中文路径

侧边导航栏

1. 先定义一个侧边导航栏，在_data/navigation.yml 文件末尾，仿照python-sdk所上传sdk的侧边栏配置。
2. 在需要使用侧边导航栏的markdown文件中顶部添加

---
catalog: true  
title: '安装'
sidebar:
  nav: python-sdk
---

注意：此处title要和侧边栏配置中相应的title一致。

代码块一键复制

在代码块外逃入一层copyable，如下：

<div class="snippet" markdown="1">

​```
def hello():
    print('Hello world!')
​```

</div>

1. 在_posts文件夹下添加md文件。注意文件名要带有日期，如：2020-12-22-US3-sdk.md。然后就访问http://localhost:4000/2020/12/22/US3-sdk.html看是否有正确博客，并且该博客会自动链接会自动添加到首页。

2. 不想把所有博客都放在一个文件夹下：

   新建文件夹，比如叫blog，然后在blog文件夹下新建_posts文件夹，添加2020-12-22-US3-sdk.md。访问链接：http://localhost:4000/blog/2020/12/22/US3-sdk.html。
   也会自动添加到首页，关于首页的修改：index.html

首页修改

在index.html文件中，以第7行为样例，在之后增添相应的sdk链接，注意修改链接名和名称

    <header><a href="/python-sdk/概述.html"><h2 itemprop="headline" class="item__header">Python SDK</h2></a></header>

主题官方文档

https://tianqi.name/jekyll-TeXt-theme/docs/zh/quick-start