98 lines
3.6 KiB
Markdown
Executable file
98 lines
3.6 KiB
Markdown
Executable file
# { Personal } Jekyll Theme
|
|
|
|
|
|
[](https://gitter.im/panossakkos/personal-jekyll-theme?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
{ Personal } is a free responsive Jekyll theme, about you :wink:
|
|
|
|
You can watch it in action [here](https://le4ker.github.io/personal-jekyll-theme/)!
|
|
|
|
<img src="https://github.com/le4ker/personal-jekyll-theme/raw/master/.github/personal-mobile.mov.gif" height="480">
|
|
|
|
<img src="https://github.com/le4ker/personal-jekyll-theme/raw/master/.github/personal-desktop.mov.gif" height="600" width="960">
|
|
|
|
## What value does { Personal } add
|
|
|
|
* Fork of [Timeline](https://github.com/kirbyt/timeline-jekyll-theme) (mashup of [Grayscale by Start Bootstrap](https://github.com/IronSummitMedia/startbootstrap-grayscale) and [Agency Jekyll Theme](https://github.com/y7kim/agency-jekyll-theme))
|
|
* Modern and minimal design
|
|
* Responsive templates for home page, blog archive and posts. Looks great on mobile, tablet, and desktop devices
|
|
* Sweet animations
|
|
* Gracefully degrades in older browsers. Compatible with Internet Explorer 8+ and all modern browsers
|
|
* Timeline
|
|
* Tell your story so far with a sleek timeline of dates, pictures and descriptions
|
|
* White on black text, making the reading experience tireless
|
|
* Google analytics
|
|
* Customization and full control of your website and blog through the site config
|
|
* Customization of the website's coloring
|
|
* Blogging functionality
|
|
* Preview of the latest post in the home page
|
|
* Archive page
|
|
* Syntax highlighting
|
|
* Emojis
|
|
* Gesture navigation in archive and post pages by swiping
|
|
* Hashtags
|
|
* Categories
|
|
* Disqus comments
|
|
* Bootstrap share buttons
|
|
* RSS feed
|
|
* Author blurb under the posts
|
|
* 404 page
|
|
* iOS and Android Web App mode
|
|
* Enforcing of https protocol
|
|
* Protection from email harvesting
|
|
* Sitemap
|
|
* Travis CI integration with [html-proofer](https://github.com/gjtorikian/html-proofer)
|
|
|
|
## Documentation
|
|
|
|
The theme contains documentation in the form of [blog posts](https://le4ker.github.io/personal-jekyll-theme/blog/index.html).
|
|
|
|
## How to run locally
|
|
|
|
First, you need to install jekyll and the dependencies of { Personal } by running:
|
|
|
|
```shell
|
|
./scripts/install
|
|
```
|
|
|
|
Then, you can build and serve your website by simply running:
|
|
|
|
```shell
|
|
./scripts/serve-production
|
|
```
|
|
|
|
To serve across lan (requires su to forward the port 4000 over lan):
|
|
|
|
```shell
|
|
./scripts/serve-lan-production
|
|
```
|
|
|
|
### Docker
|
|
|
|
Run using Docker:
|
|
|
|
```
|
|
docker run --rm -it -p 4000:4000 -v "$PWD:/srv/jekyll" jekyll/jekyll jekyll serve --watch --host "0.0.0.0" --config _config.yml,_config.dev.yml
|
|
```
|
|
|
|
Run using Docker with Docker Compose:
|
|
```
|
|
docker-compose up
|
|
```
|
|
|
|
## OSS used in { Personal }
|
|
|
|
One of the reasons { Personal } is real is the following OSS projects:
|
|
|
|
1. [Grayscale](http://startbootstrap.com/template-overviews/grayscale/)
|
|
2. [hammer.js](https://hammerjs.github.io/)
|
|
3. [highlightjs](https://highlightjs.org/)
|
|
4. [RRSSB](https://github.com/kni-labs/rrssb)
|
|
5. [Timeline](https://github.com/kirbyt/timeline-jekyll-theme)
|
|
6. [typed.js](https://github.com/mattboldt/typed.js/)
|
|
|
|
<div style="font-size:16px;margin:0 auto;width:300px">
|
|
<a href="https://blockchain.info/address/1LHuKC9Em3KA5yoZaf7nngnNdf9K7s2gSi">
|
|
<img src="https://blockchain.info/Resources/buttons/donate_64.png"/>
|
|
</a>
|
|
</div>
|