caarlos0-graveyard / up Goto Github PK

View Code? Open in Web Editor NEW

142.0 8.0 127.0 3.08 MB

Clean and beautiful bootstrap based layout for Jekyll.

Home Page: http://carlosbecker.com/posts/up-a-jekyll-theme/

License: MIT License

Ruby 19.24% JavaScript 9.56% CSS 33.05% HTML 38.16%

up's Introduction

Up

Up is a clean and beautiful Bootstrap based layout for Jekyll.

This is designed to be an easy layout to modify for your own blog. It is based on zachholman's blog themes: the "old" one, now opensourced as left, and also in his actual theme, that's not opensource (I believe), but I stole some ideas anyway. I also took something from jekyll-bootstrap, and, of course, I'm using bootstrap as a base for whole thing.

Installation

Fork this repository
Rename it to YOUR-USER.github.io
Clone it: git clone https://github.com/YOUR-USER/YOUR-USER.github.io
With Ruby, bundler, Node.js and NPM previously installed, run the init script bundle && rake init;
Start it up in watch mode: foreman start -f Procfile.dev.

You should have a server up and running locally at http://localhost:4000.

Customization

Next you'll want to change a few things. The list of files you may want to change is the following:

_config.yml: Put your config there, almost everything will be up and running.
about/index.html: Well, that's about you, I would change it if I were you... OH WAIT!
CNAME: If you're using this on GitHub Pages with a custom domain name, you might 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.ico: This is a smaller version of my gravatar for use as the icon in your browser's address bar. You may change it to whatever you like. Updating your icons.
apple-touch-icon.jpg: Again, this is my gravatar, and it shows up in iOS and various other apps that use this file as an "icon" for your site. Updating your icons.

Custom CSS/JS

Assets are now managed by bower. You could simply run grunt whenever you want to update your assets. grunt watch will also watch everything for changes.

Note: I'm not using any Jekyll asset pipeline because it's not supported by GitHub Pages, so, I prefer to do it by myself.

Update `favicon` and `apple-precomposed` icons based on gravatar

First, be sure you have the author email configured in _config.yml, then, just run:

rake icons

The script will generate your email hash and get your gravatar, then, using RMagick, it will create all needed icons.

Deployment

You should deploy with GitHub Pages- it's just easier.

All you should have to do is to rename your repository on GitHub to be username.github.io. Since this is a Jekyll project, you should be able to see your new site at http://username.github.io.

Licensing

This is MIT with no added caveats, therefore feel free to use this on your site without linking back to me or using a disclaimer or anything silly like that.

If you'd like give me, holman (from left layout), plusjade (from jekyll-bootstrap), fat and mdo (from bootstrap) credit somewhere on your all-new blog or tweet a shout out to us, well hey, sure we'll take it.

Donate

You can also thank me doing a donation =)

Thanks.

up's People

Contributors

Stargazers

Watchers

Forkers

heyfluke jlehtoma tgbyte matthewp willdignazio wfwei mattfinlayson lechoo communityinclusion kujhawk94 craigtracey diego-aslz ptgoetz ae0000 llj098 thiagolenz simonje williamhorbelt hsztul pjvds graemenelson dearroy ivanfoong tjweir walterpinson francoisliger somesaba badnotes missdora tplaner baus zuhao levent varun06 praburajasekaran johnrambo codenamev inventit kmadac leandronardo jawerty tylerselby doubleshow wchrisjohnson graysky mattbeedle munk801 naimkazi lscott3 voke anupj lintaho ppfearn dustinosity awkwardvampire hsunami matthewadavis davismlcom felixroeser chzju gerbal plen scottnyc sguilfoyle naqi324 clayh53 cruisemaniac andyt furikuri marcionicolau colombounplug piemme namilkim swimriderun jishankai glebd prannamalai shahidhk yotouchen timothyfcook lnsoso pwer21c airforge it365 zhu8 benmyles janncm roachhaus nohwnd harriyott roachhd madstt githubber maziano dmarti thayub jun1st ualmtorres 4711 georgedittmar

up's Issues

Error message at the foot of the UP home page on Github

At the very bottom of

http://caarlos0.github.com/posts/up-a-jekyll-theme/

observe:

Included file 'gauges.html' not found in _includes directory

push to bootstrap 3
use lessc to compile assets
update Rakefile/Makefile to generate the favicons
add pygments.css
bump version - tag
update readme
create a new post/edit the post about it to fit the new look/features

How can I expand the title of the page?

My super long name won't fit in the navbar-brand. Thanks!

Makefile

Do I have to touch it? I added a new css for the pygments highlighting:

$ make build
##################################################
Building Up...
##################################################
cat: css/{bootstrap,custom,monokai,bootstrap-responsive,font-awesome}.css: No such file or directory
make: *** [build] Error 1

I added monokai.css

Missing Favicon

For starters, love the theme from the bottom of my heart. Only one thing, the favicon is not appearing locally using jekyll serve or on Github pages.

I did run into some problems with rackmagic but go that sorted out.
Had all the favicons placed at the root of the file just like it was.
Tried to load with jekyll serve and nothing comes up
Pushed it to Github and still nothing.

You can visit my page here and see the problem.

Update

It works on Firefox but not on Chrome