73 lines
2.7 KiB
Markdown
73 lines
2.7 KiB
Markdown
|
# Lagom
|
||
|
|
|
||
|
|
> #### *Lagom* is a Swedish word with no direct English equivalent, meaning "just the right amount"
|
||
|
|
|
||
|
|
Lagom, a [Jekyll][j] blog theme with just the right amount of style.
|
||
|
|
|
||
|
|
Extracted lovingly from [http://mdswanson.com][mds] for your enjoyment!
|
||
|
|
|
||
|
|
* Responsive, based on [Skeleton][skeleton]
|
||
|
|
* [Font Awesome][font-awesome] for icons
|
||
|
|
* Open Sans from [Google web fonts][gfonts]
|
||
|
|
* Built-in Atom RSS feed
|
||
|
|
|
||
|
|
## Action Shots
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
- Install Jekyll: `gem install jekyll`
|
||
|
|
- [Fork this repository][fork]
|
||
|
|
- Clone it: `git clone https://github.com/YOUR-USER/lagom`
|
||
|
|
- Run the jekyll server: `jekyll serve`
|
||
|
|
|
||
|
|
You should have a server up and running locally at <http://localhost:4000>.
|
||
|
|
|
||
|
|
## Customization
|
||
|
|
|
||
|
|
Next you'll want to change a few things. Most of them can be changed directly in
|
||
|
|
[_config.yml][config]. That's where you can add your social links, change the accent
|
||
|
|
color, stuff like that.
|
||
|
|
|
||
|
|
There's a few other places that you'll want to change, too:
|
||
|
|
|
||
|
|
- [CNAME][cname]: If you're using this on GitHub Pages with a custom domain name,
|
||
|
|
you'll want to change this to be the domain you're going to use. All that should
|
||
|
|
be in here is a domain name on the first line and nothing else (like: `example.com`).
|
||
|
|
- [favicon.png][favicon]: This is the icon in your browser's address bar. You should
|
||
|
|
change it to whatever you'd like.
|
||
|
|
- [logo.png][logo]: A square-ish image that appears in the upper-left corner
|
||
|
|
|
||
|
|
## Deployment
|
||
|
|
|
||
|
|
You should deploy with [GitHub Pages][pages] - it's just easier.
|
||
|
|
|
||
|
|
All you should have to do is rename your repository on GitHub to be
|
||
|
|
`username.github.io`. Since everything is on the `gh-pages` branch, you
|
||
|
|
should be able to see your new site at <http://username.github.io>.
|
||
|
|
|
||
|
|
## Licensing
|
||
|
|
|
||
|
|
[MIT](https://github.com/swanson/lagom/blob/master/LICENSE) with no
|
||
|
|
added caveats, so feel free to use this on your site without linking back to
|
||
|
|
me or using a disclaimer or anything silly like that.
|
||
|
|
|
||
|
|
## Contact
|
||
|
|
I'd love to hear from you at [@_swanson][twitter]. Feel free to open issues if you
|
||
|
|
run into trouble or have suggestions. Pull Requests always welcome.
|
||
|
|
|
||
|
|
[j]: http://jekyllrb.com/
|
||
|
|
[mds]: http://mdswanson.com
|
||
|
|
[skeleton]: http://www.getskeleton.com/
|
||
|
|
[font-awesome]: http://fortawesome.github.io/Font-Awesome/
|
||
|
|
[gfonts]: http://www.google.com/fonts/specimen/Open+Sans
|
||
|
|
[fork]: https://github.com/swanson/lagom/fork
|
||
|
|
[config]: https://github.com/swanson/lagom/blob/master/_config.yml
|
||
|
|
[cname]: https://github.com/swanson/lagom/blob/master/CNAME
|
||
|
|
[favicon]: https://github.com/swanson/lagom/blob/master/favicon.png
|
||
|
|
[logo]: https://github.com/swanson/lagom/blob/master/logo.png
|
||
|
|
[pages]: http://pages.github.com
|
||
|
|
[twitter]: https://twitter.com/_swanson
|