Text 主题安装指南

cover

TeXt 主题与 GitHub 页面 100%兼容,并且它已被开发为基于 gem 的主题, 以便更容易使用。

一、安装主题

1、常用方法,

  • 要使用常用方法安装它,您所需要做的就是将所有主题文件复制到您的项目中。有几种方法可以做到这一点:

  • 从 github 克隆 jekyll-TeXt-theme。

使用 HTTPS 克隆:

1
git clone https://github.com/kitian616/jekyll-TeXt-theme.git

使用 SSH 克隆:

1
git clone [email protected]:kitian616/jekyll-TeXt-theme.git

-
下载并解压缩文件到您的 Jekyll 站点目录。

2、下载 TeXt 主题

  • 如果你在 GitHub Pages 上托管你的网站,你可以直接 fork jekyll-TeXt-theme,然后将仓库重命名为 USERNAME.github.io-用你的 GitHub 用户名替

USERNAME。

​ Fork

​ Rename

3、Ruby Gem Method

  • 将这一行添加到您的 Jekyll 站点的 Gemfile:
1
gem "jekyll-text-theme"
  • 将这一行添加到 Jekyll 站点的 _config.yml 文件中:
1
theme: jekyll-text-theme

二、设置您的网站

  • ​ 如果您使用普通方法安装主题,则可以直接进入下一步。但是如果你用 ruby gem 方法安装主题,你必须做一些额外的工作 。
  • ​ layouts、_includes 和 _sass 目录)存储在主题的 gem 中,隐藏在您的直接视图中。您需要在 Jekyll 站点目录中添加一些文件:

​ ├── 404.html
​ ├── Gemfile
​ ├── _config.yml
​ ├── _data
​ │ └── locale.yml
​ ├── _posts
​ │ └── …
​ ├── about.md
​ ├── archive.html
​ └── index.html

  • ​ 您可以参考 /test 文件夹 ,这是一个基于 gem 主题的示例。

三、 安装开发环境

  • ​ 如果你想在本地运行它们,你需要先安装 Ruby 和 Jekyll,详见安装 。

  • ​ 之后,运行 Replayer 来安装依赖项:

  • ​ bundle install –path vendor/bundle

  • ​ 此外,TeXt 还提供 Docker 对开发和公共的支持,这使得设置环境变得更容易。

1、Docker

​ 所有你需要做的就是这3个步骤:

2、安装 Docker。

3、生成 Gemfile.lock:

1
docker run --rm -v "$PWD":/usr/src/app -w /usr/src/app ruby:2.6 bundle install

4、构建 Docker 镜像:

​ docker-compose -f ./docker/docker-compose.build-image.yml build

四、本地预览

  • 运行 bundle exec jekyll serve 启动开发服务器,然后你可以访问 http://localhost:4000/预览你的网站。

  • 对于 Docker,运行 docker-compose -f ./docker/docker-compose.default.yml up 以启动开发服务器。

五、构建和发布

  • ​ 如果你在 GitHub Pages 上托管你的网站,只需将源推送到你的 USERNAME.github.io 存储库的主分支,GitHub 就会自动构建。您可以在几分钟后访问您的网站 https://USERNAME.github.io。

  • ​ 如果您在服务器上托管站点,则需要首先运行 JEKYLL_ENV=production bundle exec jekyll build 以生成站点,然后将 _site 文件夹中的文件更新到服务器。

欢迎关注我的其它发布渠道