Skip to content

Latest commit

 

History

History
136 lines (99 loc) · 4.41 KB

README_zh.md

File metadata and controls

136 lines (99 loc) · 4.41 KB

Minimal Light 主题

LICENSE gem Gem Jekyll Build Status

[在线演示] [English]

这个项目包含我主页的源代码. 基于GitHub官方主题之一minimal创建
如果您喜欢这个项目，欢迎您使用和分享

项目特点

  • 简单优雅的学术个人主页模板
  • 基于Jekyll, 可以在GitHub Pages服务下自动部署
  • 基本的搜索引擎优化
  • 移动端适配
  • 支持Markdown
  • 支持自动的暗黑模式

使用指南

在GitHub上使用

只要在你的项目中添加如下内容的_config.yml文件，GitHub Pages服务就会使用该主题部署网页:

remote_theme: yaoyao-liu/minimal-light

请注意：添加上述内容到你的项目，会直接应用这个仓库的所有的默认设置。

如果你希望编辑任何文件（例如：index.md)，你仍需要把该文件拷贝到你的项目中。

你也可以直接fork这个仓库，然后把仓库的名字改为your-username.github.io.

在GitHub上使用自定义域名

在你的DNS设置中添加如下的CNAME解析记录：

Host: 根据需求自定义，例如： "www" 
Target / Canonical name: your-username.github.io.
TTL: 10 min

你也可以添加如下的A解析记录（如果无法使用CNAME记录的话）：

Host: 根据需求自定义，例如： "www" 或 "@"
IP: 185.199.108.153
    185.199.109.153
    185.199.110.153
    185.199.111.153
TTL: 10 min

然后，编辑这个仓库中 CNAME 文件的内容为你自定义的域名。

通过Jekyll在本地使用

首先你需要安装Ruby and Jekyll.

克隆这个项目:

git clone https://github.com/yaoyao-liu/minimal-light.git
cd minimal-light

安装并运行:

bundle install
bundle exec jekyll server

在localhost预览网页: http://localhost:4000. You can get the html files in _site folder.

自定义内容

配置变量

Minimal Light 主题有以下的变量, 你可以在_config.yml文件中修改:

title: 你的名字
affiliation: 你的单位
email: yourname (at) example.edu
google_scholar: https://scholar.google.com/
github_link: https://github.com/yaoyao-liu/minimal-light
linkedin: https://www.linkedin.com/
avatar: ./assets/img/avatar.png
google_analytics: UA-111540567-4
favicon: ./assets/img/favicon.png
favicon_dark: ./assets/img/favicon-dark.png
description: 在这里输入网页描述.
canonical: https://minimal-light.yyliu.net/
remote_theme: yaoyao-liu/minimal-light

编辑 index.md

创建index.md并添加你的个人信息(如：发表的论文，研究课题等).

网页样式（CSS)

如果你需要修改网页的风格（基于CSS）:

  1. 在你的项目中创建/assets/css/style.scss文件

  2. 在该文件的顶端加入如下内容:

    ---
---

@import "{{ site.theme }}";

  3. 在@import那一行添加自定义CSS(或Sass)格式

网页样式（基于html）

如果你需要修改网页的html样式:

  1. 从本项目中复制原始模板
    (小提示: 点击"raw"可以直接显示原始文件, 拷贝起来更方便)
  2. 在你的项目中创建/_layouts/homepage.html文件
  3. 把第一步中复制的原始模板粘贴进去
  4. 根据自己的需求修改html文件

许可证

这个项目使用Creative Commons Zero v1.0 Universal许可证.

致谢

我们的项目用到了以下项目的源代码: