How to use and contribute?
Start
- 更新个人基本信息
_data/authors.yml
- 更新个人主页
_people/
- 更新个人图片
images/
- 其他附件
files/
Basic
- front matter: 页面中最前面yml格式的配置选项信息(—包围),若干有用的配置
- author: 页面人物,对应
_data/authors.yml
中的人 - author_profile: 是否在网页侧边栏显示author信息
- permalink:页面的永久链接,可以设置其他跳转页面
- redirect_from:可重定向过来的页面
- title: 页面标题,即显示在当前页面的
<h1>
标签 - lang: 页面语言(目前支持eng、chs中英文切换)
- uuid:页面唯一标识(不同语言共享uuid),与lang配合使用
- sidebar:网页侧边栏配置
- toc:显示当前页面目录(尚未实现)
- nav:额外导航菜单,对应
_data/navigation.yml
中的菜单(支持2级) - image:额外图片展示,支持多张图片,title、text显示
- tags:页面tag,可以用于聚合特定类型页面
- 预置几个tag:faculty、phd、master、undergrad、alumni
- categories:页面分类,可以用于聚合特定类型页面
- 预置几个category:people
- layout: 页面布局,对应
_layouts/
中定义的各种布局,一般不用写这个(_config.yml
中已设置默认值)
- author: 页面人物,对应
- 页面中可以混用HTML/Markdown语法
- 页面第一个HTML标签中的内容,会作为缩略信息显示在archive页面(例如
/people/
,/talks/
,/posts/
等),参考下面advanced说明
- 页面第一个HTML标签中的内容,会作为缩略信息显示在archive页面(例如
中文/英文支持
- 中英文页面front matter设置
- uuid页面标识
- uuid必须保证全局唯一,可以用uuidgen等命令生成,或者自己写一个随机串
- 中英文页面的uuid必须相同
- lang页面语言:eng,chs
- permalink链接
- 链接不能一样,建议:英文页面 /path, 中文页面 /chs/path
- uuid页面标识
- 分别编写中文、英文两个页面,放到同一个合适文件夹(文件名不重要,front matter中的
permalink
比较关键)- 个人主页放在
_people/
- 论文信息放在
_publications/
- 组会论文分享放在
_seminars/
- 邀请报告信息放在
_talks/
- 比赛成绩信息放在
_hacking/
- 个人主页放在
Advanced
- 全局设置:
_config.yml
- 导航菜单设置:
_data/navigation.yml
- 顶部导航栏,代码:
_includes/masthead.html
- 网页侧边栏,代码:
_includes/sidebar.html
- front matter中author基本信息,样式:
_includes/author-profile.html
- front matter中sidebar设置,支持下面三种显示
- 目录toc,依赖于
jekyll-toc
插件,尚未完成 - 导航nav,对应
_data/navigation.yml
中定义的菜单,代码:_includes/nav_list.html
- 图片image,支持多张图片,以及title、text显示
- 目录toc,依赖于
- front matter中author基本信息,样式:
- 网页footer,代码:
_includes/footer.html
- 网页主体:
- 顶级页面:
_pages/
,一般是展示某个目录下的页面合集 - 内容页面:html/md,一般放在某个目录下,被某个顶级页面索引
- 顶级页面:
- 页面缩略信息,样式
_includes/archive-single.html
- archive页面,按不同标准聚合(#)
- posts,代码
_pages/post-archive.html
,链接/posts/
- pages,代码
_pages/page-archive.html
,链接/pages/
- collections,代码
_pages/collection-archive.html
,链接/collections/
- categories,代码
_pages/category-archive.html
,链接/categories/
- tags,代码
_pages/tag-archive.html
,链接/tags/
- posts,代码
- related页面:
_layouts/single.html
,_layouts/talk.html
- 内容页面的关联项,例如post的前/后post链接,talk的前/后talk链接
- archive页面,按不同标准聚合(#)
News 页面 /news/
- 内容页面位置:_posts/
Seminars 页面 /seminars/
- 内容页面位置:_posts/
- 内容页面categories: seminar
安全赛事页面 /hacking/
- 内容页面位置:_posts/
- 内容页面 categories: hacking
People 页面 /people/
- 内容页面位置:_people/
- 设置合适tags:faculty, phd, master, undergrad、alumni
Publications 页面 /publications/
- 内容页面位置:_publications/
Talks 页面 /talks/
- 内容页面位置:_talks/
Teaching 页面 /teaching/
- 内容页面位置:_teaching/
Markdown 用法
Tips and hints
- Name a file “.md” to have it render in markdown, name it “.html” to render in HTML.
- Go to the commit list (on your repo) to find the last version Github built with Jekyll.
- Green check: successful build
- Orange circle: building
- Red X: error
- No icon: not built
Resources
Markdown guide
Header three
Header four
Header five
Header six
Blockquotes
Single line blockquote:
Quotes are cool.
Tables
Table 1
Entry | Item | |
---|---|---|
John Doe | 2016 | Description of the item in the list |
Jane Doe | 2019 | Description of the item in the list |
Doe Doe | 2022 | Description of the item in the list |
Table 2
Header1 | Header2 | Header3 |
---|---|---|
cell1 | cell2 | cell3 |
cell4 | cell5 | cell6 |
cell1 | cell2 | cell3 |
cell4 | cell5 | cell6 |
Foot1 | Foot2 | Foot3 |
Definition Lists
- Definition List Title
- Definition list division.
- Startup
- A startup company or startup is a company or temporary organization designed to search for a repeatable and scalable business model.
- #dowork
- Coined by Rob Dyrdek and his personal body guard Christopher “Big Black” Boykins, “Do Work” works as a self motivator, to motivating your friends.
- Do It Live
- I’ll let Bill O’Reilly explain this one.
Unordered Lists (Nested)
- List item one
- List item one
- List item one
- List item two
- List item three
- List item four
- List item two
- List item three
- List item four
- List item one
- List item two
- List item three
- List item four
Ordered List (Nested)
- List item one
- List item one
- List item one
- List item two
- List item three
- List item four
- List item two
- List item three
- List item four
- List item one
- List item two
- List item three
- List item four
Buttons
Make any link standout more when applying the .btn
class.
Notices
Watch out! You can also add notices by appending {: .notice}
to a paragraph.
HTML Tags
Address Tag
1 Infinite LoopCupertino, CA 95014
United States
Anchor Tag (aka. Link)
This is an example of a link.
Abbreviation Tag
The abbreviation CSS stands for “Cascading Style Sheets”.
Cite Tag
“Code is poetry.” —Automattic
Code Tag
You will learn later on in these tests that word-wrap: break-word;
will be your best friend.
Strike Tag
This tag will let you strikeout text.
Emphasize Tag
The emphasize tag should italicize text.
Insert Tag
This tag should denote inserted text.
Keyboard Tag
This scarcely known tag emulates keyboard text, which is usually styled like the <code>
tag.
Preformatted Tag
This tag styles large blocks of code.
.post-title { margin: 0 0 5px; font-weight: bold; font-size: 38px; line-height: 1.2; and here's a line of some really, really, really, really long text, just to see how the PRE tag handles it and to find out how it overflows; }
Quote Tag
Developers, developers, developers…
–Steve Ballmer
Strong Tag
This tag shows bold text.
Subscript Tag
Getting our science styling on with H2O, which should push the “2” down.
Superscript Tag
Still sticking with science and Isaac Newton’s E = MC2, which should lift the 2 up.
Variable Tag
This allows you to denote variables.