This repository is the source code of Linping's website. I created this website mainly based on Dominik Moritz's template, with some modifications borrowed from my labmates Shelly and Haotian. It was written with Jekyll.
Like my website? Go through the following three steps to create your own website!
- Clone this repository to your computer.
- Follow the official instruction to install Jekyll and its dependencies.
- Go to the root directory and run the code with the following command in the terminal.
bundle exec jekyll build
bundle exec jekyll serve
gem install
or bundle install
may be needed to install other dependencies.
If running successfully, you can open localhost:4000 to visit the website.
Go through the official tutorial to learn the usage of Jekyll and this article to understand its common file structure.
root directory
| _config.yml
| style.scss
| index.md
| publications.md
| projects.md
| cv.html
| _layouts/
| _sass/
| _includes/
| _data/
| _publication/
| assets/
| images/
| _site/
_config.yml
is the configuration file. We can define variables here, which can be accessed globally by {{site.variable_name}}.style.scss
defines gloable variables to control styles. It also imports .scss from_layouts/
.index.md
,publications.md
,publications.md
are the entries. Their front matter indicates its layout and class, which control the layout and styles of a webpage, respectively. Thelayout
property links to corresponding files in_layouts/
, and theclass
property links to corresponding files in_sass/
._includes/
contains files that show up on every page, such as header and footer. It also contains files that implement the complex layout, interaction, and content. To import the files in_includes/
to other files, using{% include xx.html xx1=xx1%}
._data/
and_publication/
stores data referred in other files. Usingsite.data.file_name
to gbet the data.assets/
andimages/
are assets._site/
is automatically generated. No need to edit it.
If the current template meets all your needs, what you need to do to create your website is simple.
- Change my personal information to your information. They are mainly in the following files:
_config.yml
,index.md
,_includes/footer.html
,_includes/head.html
, andcv.html
. - Modify or update files in
_data/
and add assets toassets/
.
You can modify the template to meet your needs.
- Change layouts or styles: go to the
_layouts/
and_sass/
folder. - Add a new tab in addition to
Publications
,Projects
, andCV
: add a new .md file in the root directory. You may also need to add corresponding files in_layouts/
,_sass/
,_includes/
, and_data/
.