|
| 1 | +<div align="center"> |
| 2 | + <div align="right"> |
| 3 | + <a href="README.md">简体中文</a> | English |
| 4 | + </div> |
| 5 | + <h1>donglinanshan.github.io</h1> |
| 6 | + <p>A responsive personal blog website based on jekyll.</p> |
| 7 | + |
| 8 | +[](https://github.com/donglinanshan/donglinanshan.github.io/blob/master/COPYING) |
| 9 | +[](https://gitter.im/donglinanshan-github-io/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) |
| 10 | +[](https://donglinanshan.github.io) |
| 11 | +[](https://github.com/donglinanshan/donglinanshan.github.io/deployments) |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | +[](https://github.com/donglinanshan/donglinanshan.github.io/issues) |
| 18 | +[](https://github.com/donglinanshan/donglinanshan.github.io/pulls) |
| 19 | + |
| 20 | +[](https://github.com/donglinanshan/donglinanshan.github.io/commit/master) |
| 21 | +[](https://github.com/donglinanshan/donglinanshan.github.io/graphs/commit-activity) |
| 22 | + |
| 23 | +</div> |
| 24 | + |
| 25 | +## Features |
| 26 | + |
| 27 | +- Responsive for mobile phone, tablet, desktop | [Preview](https://donglinanshan.github.io) |
| 28 | +- Show your GitHub repository fantastically | [Preview](https://donglinanshan.github.io/projects) |
| 29 | +- Archive your articles with categories and tags | [Preview](https://donglinanshan.github.io/categories) |
| 30 | +- Support search articles with key words | [Preview](https://donglinanshan.github.io) |
| 31 | +- Customized “About” page | [Preview](https://donglinanshan.github.io/about) |
| 32 | + |
| 33 | +## Usage |
| 34 | + |
| 35 | +Detailed tutorial:[Build Github Pages blog website](https://donglinanshan.github.io/2018/04/01/github-pages-blog) |
| 36 | + |
| 37 | +jekyll guide:<https://www.jekyll.com.cn/> |
| 38 | + |
| 39 | +## Configuration |
| 40 | + |
| 41 | +The configuration file `_config.yml` locates in the root directory, looking for more details about the parameters of this file, please see the official documentation: <https://www.jekyll.com.cn/docs/configuration/> |
| 42 | + |
| 43 | +Example config of my website: |
| 44 | +```yml |
| 45 | +# Welcome to Jekyll! |
| 46 | +# |
| 47 | +# This config file is meant for settings that affect your whole blog, values |
| 48 | +# which you are expected to set up once and rarely edit after that. If you find |
| 49 | +# yourself editing this file very often, consider using Jekyll's data files |
| 50 | +# feature for the data you need to update frequently. |
| 51 | +# |
| 52 | +# For technical reasons, this file is *NOT* reloaded automatically when you use |
| 53 | +# 'bundle exec jekyll serve'. If you change this file, please restart the server process. |
| 54 | + |
| 55 | +# Global variable, can use it in HTML file, |
| 56 | +# for example: <h1>{{ site.title }}</h1> |
| 57 | +title: ***的博客 # title for your website |
| 58 | +description: > # description for your website, useful for search engine exhibition. |
| 59 | + 基于 jekyll 的 Github Pages 个人博客网站,技术的学习、总结、分享与提升 |
| 60 | +url: "https://donglinanshan.github.io" # address of your website. |
| 61 | +github_repo: donglinanshan/donglinanshan.github.io |
| 62 | +github_profile: "https://github.com/donglinanshan" # your GitHub home page. |
| 63 | +user: "***" # name in the sidebar |
| 64 | +user_email: "liang_zhi_bo@foxmail.com" # contact email in the sidebar |
| 65 | +paginate: 5 # how many articles will show in your website home page. |
| 66 | + |
| 67 | +# configuration related to jekyll |
| 68 | +markdown: kramdown |
| 69 | +repository: donglinanshan/donglinanshan.github.io |
| 70 | +plugins: |
| 71 | + - jekyll-feed |
| 72 | + - jekyll-paginate |
| 73 | + - jekyll-seo-tag |
| 74 | + - jekyll-sitemap |
| 75 | +exclude: |
| 76 | + - Gemfile |
| 77 | + - Gemfile.lock |
| 78 | + - vendor |
| 79 | + - README.md |
| 80 | + - COPYING |
| 81 | +sass: |
| 82 | + style: compressed |
| 83 | +future: true |
| 84 | +permalink: /:year/:month/:day/:title |
| 85 | +``` |
| 86 | +
|
| 87 | +## Development |
| 88 | +
|
| 89 | +Commit and push your code to the remote repo, you may wait for a long time to see the change of your blog website, so recommend build develop environment in local, convenient for debugging. |
| 90 | +
|
| 91 | +Detialed tutorial: [Install jekyll](https://donglinanshan.github.io/2018/04/01/github-pages-blog#%E5%AE%89%E8%A3%85jekyll-) |
| 92 | +
|
| 93 | +run code bellow in shell after configuring well: |
| 94 | +```cmd |
| 95 | +bundle exec jekyll s |
| 96 | +``` |
| 97 | + |
| 98 | +Then shell will print a message about open `http://127.0.0.1:4000` in browser to preview the website. Normally, what you see is the same as real GitHub Pages website, so, push your code to github after testing it well. |
| 99 | + |
| 100 | +## Libraries |
| 101 | + |
| 102 | +- [Materialize.css](http://materializecss.com/):Famous materialize css style library. |
| 103 | +- [GeoPattern](http://btmills.github.io/geopattern/):Generate intersting backgroud images. |
| 104 | +- [Animate.css](https://daneden.github.io/animate.css/):Library for animations. |
| 105 | +- [Morphtext](http://morphext.fyianlai.com/):Let your words moving! |
| 106 | +- [particles.js](https://marcbruederlin.github.io/particles.js/):Particle lines effect. |
| 107 | + |
| 108 | +## Reference |
| 109 | + |
| 110 | +- https://github.com/ShawnTeoh/matjek |
| 111 | +- https://github.com/knightyun/knightyun.github.io |
| 112 | + |
| 113 | +## Thanks |
| 114 | +- https://github.com/knightyun/knightyun.github.io |
| 115 | + |
| 116 | +## License |
| 117 | +[GPL v3](https://github.com/donglinanshan/donglinanshan.github.io/blob/master/COPYING) |
0 commit comments