https://jarrekk.github.io/Jalpc/
- 3 steps to setup this theme at your website!
- Features
- Put in a Jalpc Plug
- Upgrading Jalpc
- Thanks to the following
- Todo
- Change Log
- Donate Jalpc
- Ad
This is a simple, beautiful and swift theme for Jekyll. It's mobile first, fluidly responsive, and delightfully lightweight.
If you're completely new to Jekyll, I recommend checking out the documentation at http://jekyllrb.com or there's a tutorial by Smashing Magazine.
Here is a document of how to setup this theme with 3 steps and a wiki of how to add posts. If you have any questions please ask me at GitHub Issues.
The index page is seprated into several sections and they are located in _includes/sections,the configuration is in _data/landing.yml and section's detail configuration is in _data/*.yml.
These files are used to dynamically render pages, so you almost don't have to edit html files to change your own theme, besides you can use jekyll serve --watch to reload changes.
The following is mapping between yml files to sections.
- landing.yml ==> index.html
- index/language.yml ==> index.html
- index/careers.yml ==> _includes/sections/career.html
- index/skills.yml ==> _includes/sections/skills.html
- index/projects.yml ==> _includes/sections/projects.html
- index/links.yml ==> _includes/sections/links.html
This yml file is about blog page navbar
- blog.yml ==> _includes/header.html
The following is mapping between yml files to donation
- donation/donationlist.yml ==> blog/donate.html
- donation/alipay.yml ==> blog/donate.html
- donation/wechat_pay.yml ==> blog/donate.yml
I use Chart.js to show skills, the type of skills' chart is radar, if you want to custom, please read document of Chart.js and edit _includes/sections/skills.html and _data/index/skills.yml.
In blog page, we categorize posts into several categories by url, all category pages use same template html file - _includes/category.html.
For example: URL is http://127.0.0.1:4000/python/. In _data/blog.yml, we define this category named Python, so in _includes/category.html we get this URL(/python/) and change it to my category(Python), then this page are posts about Python. The following code is about how to get url and display corresponding posts in _includes/category.html.
<div class="row">
<div class="col-lg-12 text-center">
<div class="navy-line"></div>
{% assign category = page.url | remove:'/' | capitalize %}
{% if category == 'Html' %}
{% assign category = category | upcase %}
{% endif %}
<h1>{{ category }}</h1>
</div>
</div>
<div class="wrapper wrapper-content animated fadeInRight blog">
<div class="row">
<ul id="pag-itemContainer" style="list-style:none;">
{% assign counter = 0 %}
{% for post in site.categories[category] %}
{% assign counter = counter | plus: 1 %}
<li>The pagination in jekyll is not very perfect,so I use front-end web method,there is a blog about the method and you can refer to jPages.
Many third party page counter platforms are too slow,so I count my website page view myself,the javascript file is static/js/count.min.js (static/js/count.js),the backend API is written with flask on Vultr VPS, detail code please see jalpc-flask.
The landing page has multilingual support with the i18next plugin.
Languages are configured in the _data/index/language.yml file.
Not everyone needs this feature, so I make it very easy to remove it, just clear content in file
_data/language.ymland folderstatic/locales/.
About how to custom multilingual page, please see wiki.
I use Google analytics and GrowingIO to do web analytics, you can choose either to realize it,just register a account and replace id in _config.yml.
I use Disqus to realize comment. You should set disqus_shortname and get public key and then, in _config.yml, edit the disqus value to enable Disqus.
I use AddToAny to share my blog on other social network platform. You can go to this website to custom your share buttons and paste code at _includes/share.html.
I use javascript to realize blog search,you can double click Ctrl or click the icon at lower right corner of the page,the detail you can got to this repository. Just use it.
All CSS and JS files are compressed at /static/assets.
I use UglifyJS2, clean-css and purifycss to compress/purify CSS and JS files. If you want to custom CSS and JS files, you need to do the following:
- Install NPM then install UglifyJS2 and clean-css:
npm install -g uglifyjs; npm install -g clean-css, then runnpm installat root dir of project. - Compress script is build.js, index page has its own CSS and JS compressed files, they are :
- app-xxx.min.css
- app-index-xxx.min.js
- i18-xxx.min.js
404 page are
- app-xxx.min.css
- fof-xxx.min.js
other pages are
- app-xxx.min.css
- app-xxx.min.js
- jPage-xxx.min.js
xxx is date when you compress your files.
3. If you want to add or remove CSS/JS files, just edit build/build.js and build/files.conf.js, then run npm run build at root dir of project, link/src files will use new files.
If you want to give credit to the Jalpc theme with a link to my personal website http://www.jarrekk.com, that'd be awesome. No worries if you don't.
Jalpc is always being improved by its users, so sometimes one may need to upgrade.
If git remote -v doesn't have an upstream listed, you can do the following to add it:
git remote add upstream https://github.com/jarrekk/Jalpc.git
git pull upstream gh-pages
There may be merge conflicts, so be sure to fix the files that git lists if they occur. That's it!
- Jekyll
- Bootstrap
- jPages
- i18next
- pixyll
- androiddevelop
- UglifyJS2
- clean-css
- Chart.js
- shelljs
- colors
- Font Awesome
- Font Mfizz
-
jekyll server --watchmode need to use original CSS/JS files
Please see wiki
If this project let you enjoy your blog time, you can give me a cup of coffee :)
