- Fork it
- Syncing your fork
- Create your blog branch (git checkout -b your-blog)
- Write your blog in markdown
- Add your blog to
_post
folder - Add related image to
assets
folder - Add your info into
_data/authors.yml
- Commit your changes (git commit -am 'added a blog')
- Push to the branch
- Create new Pull Request
Done!~
All blog should has title, author, date, teaser...
Example as follows:
---
title: "'Score Your Face Photo' a ML&Develop practice"
date: 2017-09-18 09:00 +0800
author: your_github_username
header:
teaser: your_teaser_image_path
---
<!-- markdownlint-disable -->
> Author: [@your_github_username](https://github.com/your_github_username) your one-line bio at here
> Code: [@yourcode](your_code_path)
- Keep all filenames & url as lowercase, and use
-
to connect words instead of space. e.g.2017-10-06-develop-pc-impactor
instead of2017-10-06-Develop PC Impactor
- Find a good image for the blog to make it more beautiful.
- Embed the photo & video before publishing, save all external file to the blog
/assets/${current_year}
directory.
Add <!--more-->
section for your abstract part, it will show on the blog homepage, or the blog homepage will show all your blog content.
Please do not commit unrelated files.
The titles in markdown files will be added an anchor automatically, you can use that to add your own anchor links. And here is some of the rules how the blog generate the anchor:
- convert the title directly to anchor
- spaces will be replaced by dash
-
/
,&
,?
and.
will be eliminated- Chinese character will be kept in the anchor
Say you have a title as ### 我是? a title.bat
. Then you will get the anchor generated as 我是-a-titlebat
. And you can use the generated anchor to implement your own links. Like this:
[奇妙的Link](#我是-a-titlebat)
Install all the Jekyll requirements and run it at localhost for blog preview.
This is the recommended way for new users to easy getting started
make docker
You should not use this way except you are a Ruby expert.
make install
make serve
In order to make sure everything(file name, file size, etc) is ok, you can run the following command to check them before git push
.
npm install
npm test
minima: https://github.com/jekyll/minima
(张春生), <zhangchunsheng423@gmail.com>
- Code & Docs © 2014-now Chunsheng Zhang <zhangchunsheng423@gmail.com>
- Code released under the Apache-2.0 License
- Docs released under Creative Commons