|
1 | | -setup in progress! |
| 1 | +# Pixyll |
| 2 | + |
| 3 | +[pixyll.com](http://www.pixyll.com) |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +Pixyll is a simple, beautiful theme for Jekyll that emphasizes content rather than aesthetic fluff. It's mobile _first_, fluidly responsive, and delightfully lightweight. |
| 8 | + |
| 9 | +It's pretty minimal, but leverages large type and drastic contrast to make a statement, on all devices. |
| 10 | + |
| 11 | +This Jekyll theme was crafted with <3 by [John Otander](http://johnotander.com) |
| 12 | +([@4lpine](https://twitter.com/4lpine)). |
| 13 | + |
| 14 | +中文版 <https://github.com/ee0703/pixyll-zh-cn>. |
| 15 | + |
| 16 | +## Getting Started |
| 17 | + |
| 18 | +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](http://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/). |
| 19 | + |
| 20 | +### Installing Jekyll |
| 21 | + |
| 22 | +If you don't have Jekyll already installed, you will need to go ahead and do that. |
| 23 | + |
| 24 | +``` |
| 25 | +$ gem install jekyll |
| 26 | +``` |
| 27 | + |
| 28 | +#### Verify your Jekyll version |
| 29 | + |
| 30 | +It's important to also check your version of Jekyll since this project uses Native Sass which |
| 31 | +is [only supported by 2.0+](http://jekyllrb.com/news/2014/05/06/jekyll-turns-2-0-0/). |
| 32 | + |
| 33 | +``` |
| 34 | +$ jekyll -v |
| 35 | +# This should be jekyll 2.0.0 or later |
| 36 | +``` |
| 37 | + |
| 38 | +### Fork, then clone |
| 39 | + |
| 40 | +Fork the repo, and then clone it so you've got the code locally. |
| 41 | + |
| 42 | +### Modify the _config.yml |
| 43 | + |
| 44 | +The `_config.yml` located in the root of the Pixyll directory contains all of the configuration details |
| 45 | +for the Jekyll site. The defaults are: |
| 46 | + |
| 47 | +```yml |
| 48 | +# Site settings |
| 49 | +title: Pixyll |
| 50 | + |
| 51 | +author: John Otander |
| 52 | +description: "A simple, beautiful theme for Jekyll that emphasizes content rather than aesthetic fluff." |
| 53 | +baseurl: "" |
| 54 | +url: "http://pixyll.com" |
| 55 | + |
| 56 | +# Build settings |
| 57 | +markdown: kramdown |
| 58 | +permalink: pretty |
| 59 | +paginate: 3 |
| 60 | +``` |
| 61 | +
|
| 62 | +### Jekyll Serve |
| 63 | +
|
| 64 | +Then, start the Jekyll Server. I always like to give the `--watch` option so it updates the generated HTML when I make changes. |
| 65 | + |
| 66 | +``` |
| 67 | +$ jekyll serve --watch |
| 68 | +``` |
| 69 | +
|
| 70 | +Now you can navigate to `localhost:4000` in your browser to see the site. |
| 71 | +
|
| 72 | +### Using Github Pages |
| 73 | +
|
| 74 | +You can host your Jekyll site for free with Github Pages. [Click here](https://pages.github.com/) for more information. |
| 75 | +
|
| 76 | +#### A configuration tweak if you're using a gh-pages sub-folder |
| 77 | +
|
| 78 | +In addition to your github-username.github.io repo that maps to the root url, you can serve up sites by using a gh-pages branch for other repos so they're available at github-username.github.io/repo-name. |
| 79 | +
|
| 80 | +This will require you to modify the `_config.yml` like so: |
| 81 | +
|
| 82 | +```yml |
| 83 | +# Site settings |
| 84 | +title: Repo Name |
| 85 | + |
| 86 | +author: John Otander |
| 87 | +description: "Repo description" |
| 88 | +baseurl: "/repo-name" |
| 89 | +url: "http://github-username.github.io" |
| 90 | +
|
| 91 | +# Build settings |
| 92 | +markdown: kramdown |
| 93 | +permalink: pretty |
| 94 | +paginate: 3 |
| 95 | +``` |
| 96 | + |
| 97 | +This will ensure that the the correct relative path is constructed for your assets and posts. Also, in order to run the project locally, you will need to specify the blank string for the baseurl: `$ jekyll serve --baseurl ''`. |
| 98 | + |
| 99 | +##### If you don't want the header to link back to the root url |
| 100 | + |
| 101 | +You will also need to tweak the header include `/{{ site.baseurl }}`: |
| 102 | + |
| 103 | +```html |
| 104 | +<header class="site-header px2 px-responsive"> |
| 105 | + <div class="mt2 wrap"> |
| 106 | + <div class="measure"> |
| 107 | + <a href="{{ site.url }}/{{ site.baseurl }}">{{ site.title }}</a> |
| 108 | + <nav class="site-nav right"> |
| 109 | + {% include navigation.html %} |
| 110 | + </nav> |
| 111 | + </div> |
| 112 | + </div> |
| 113 | +</header> |
| 114 | +``` |
| 115 | + |
| 116 | +A relevant Jekyll Github Issue: <https://github.com/jekyll/jekyll/issues/332> |
| 117 | + |
| 118 | +### Contact Form |
| 119 | + |
| 120 | +If you'd like to keep the contact form, which uses <http://formspree.io/>, you will need to update the email address. |
| 121 | + |
| 122 | +Currently, the `contact.md` has the following: |
| 123 | + |
| 124 | +```html |
| 125 | +< form action= "https://formspree.io/[email protected]" method= "POST" class= "form-stacked form-light"> |
| 126 | +``` |
| 127 | + |
| 128 | +Where it says `[email protected]`, you will need to change that to the email that you wish to have the form data sent to. It will require you to fill the form out when you push it live for the first time so that you can confirm your email. |
| 129 | + |
| 130 | +### Page Animation |
| 131 | + |
| 132 | +If you would like to add a [fade-in-down effect](http://daneden.github.io/animate.css/), you can add `animated: true` to your `_config.yml`. |
| 133 | + |
| 134 | +### Put in a Pixyll Plug |
| 135 | + |
| 136 | +If you want to give credit to the Pixyll theme with a link to <http://pixyll.com> or my personal website <http://johnotander.com> somewhere, that'd be awesome. No worries if you don't. |
| 137 | + |
| 138 | +### Enjoy |
| 139 | + |
| 140 | +I hope you enjoy using Pixyll. If you encounter any issues, please feel free to let me know by creating an [issue](https://github.com/johnotander/pixyll/issues). I'd love to help. |
| 141 | + |
| 142 | +## Upgrading Pixyll |
| 143 | + |
| 144 | +Pixyll is always being improved by its users, so sometimes one may need to upgrade. |
| 145 | + |
| 146 | +#### Ensure there's an upstream remote |
| 147 | + |
| 148 | +If `git remote -v` doesn't have an upstream listed, you can do the following to add it: |
| 149 | + |
| 150 | +``` |
| 151 | +git remote add upstream https://github.com/johnotander/pixyll.git |
| 152 | +``` |
| 153 | + |
| 154 | +#### Pull in the latest changes |
| 155 | + |
| 156 | +``` |
| 157 | +git pull upstream master |
| 158 | +``` |
| 159 | + |
| 160 | +There may be merge conflicts, so be sure to fix the files that git lists if they occur. That's it! |
| 161 | + |
| 162 | +## Contributing |
| 163 | + |
| 164 | +1. Fork it |
| 165 | +2. Create your feature branch (`git checkout -b my-new-feature`) |
| 166 | +3. Commit your changes (`git commit -am 'Add some feature'`) |
| 167 | +4. Push to the branch (`git push origin my-new-feature`) |
| 168 | +5. Create new Pull Request |
| 169 | + |
| 170 | +## Thanks to the following: |
| 171 | + |
| 172 | +* [BASSCSS](http://basscss.com) |
| 173 | +* [Jekyll](http://jekyllrb.com) |
| 174 | +* [Refills](http://refills.bourbon.io/) |
| 175 | +* [Solarized](http://ethanschoonover.com/solarized) |
| 176 | +* [Animate.css](http://daneden.github.io/animate.css/) |
0 commit comments