|
1 | | -# Jekyll Now |
| 1 | +# supercoderz |
2 | 2 |
|
3 | | -**Jekyll** is a static site generator that's perfect for GitHub hosted blogs ([Jekyll Repository](https://github.com/jekyll/jekyll)) |
4 | | - |
5 | | -**Jekyll Now** makes it easier to create your Jekyll blog, by eliminating a lot of the up front setup. |
6 | | - |
7 | | -- You don't need to touch the command line |
8 | | -- You don't need to install/configure ruby, rvm/rbenv, ruby gems :relaxed: |
9 | | -- You don't need to install runtime dependancies like markdown processors, Pygments, etc |
10 | | -- If you're on Windows, this will make setting up Jekyll a lot easier |
11 | | -- It's easy to try out, you can just delete your forked repository if you don't like it |
12 | | - |
13 | | -In a few minutes you'll be set up with a minimal, responsive blog like the one below giving you more time to spend on writing epic blog posts! |
14 | | - |
15 | | - |
16 | | - |
17 | | -## Quick Start |
18 | | - |
19 | | -### Step 1) Fork Jekyll Now to your User Repository |
20 | | - |
21 | | -Fork this repo, then rename the repository to yourgithubusername.github.io. |
22 | | - |
23 | | -Your Jekyll blog will often be viewable immediately at <http://yourgithubusername.github.io> (if it's not, you can often force it to build by completing step 2) |
24 | | - |
25 | | - |
26 | | - |
27 | | -### Step 2) Customize and view your site |
28 | | - |
29 | | -Enter your site name, description, avatar and many other options by editing the _config.yml file. You can easily turn on Google Analytics tracking, Disqus commenting and social icons here too. |
30 | | - |
31 | | -Making a change to _config.yml (or any file in your repository) will force GitHub Pages to rebuild your site with jekyll. Your rebuilt site will be viewable a few seconds later at <http://yourgithubusername.github.io> - if not, give it ten minutes as GitHub suggests and it'll appear soon |
32 | | - |
33 | | -> There are 3 different ways that you can make changes to your blog's files: |
34 | | -
|
35 | | -> 1. Edit files within your new username.github.io repository in the browser at GitHub.com (shown below). |
36 | | -> 2. Use a third party GitHub content editor, like [Prose by Development Seed](http://prose.io). It's optimized for use with Jekyll making markdown editing, writing drafts, and uploading images really easy. |
37 | | -> 3. Clone down your repository and make updates locally, then push them to your GitHub repository. |
38 | | -
|
39 | | - |
40 | | - |
41 | | -### Step 3) Publish your first blog post |
42 | | - |
43 | | -Edit `/_posts/2014-3-3-Hello-World.md` to publish your first blog post. This [Markdown Cheatsheet](http://www.jekyllnow.com/Markdown-Style-Guide/) might come in handy. |
44 | | - |
45 | | - |
46 | | - |
47 | | -> You can add additional posts in the browser on GitHub.com too! Just hit the + icon in `/_posts/` to create new content. Just make sure to include the [front-matter](http://jekyllrb.com/docs/frontmatter/) block at the top of each new blog post and make sure the post's filename is in this format: year-month-day-title.md |
48 | | -
|
49 | | -## Local Development |
50 | | - |
51 | | -1. Install Jekyll and plug-ins in one fell swoop. `gem install github-pages` This mirrors the plug-ins used by GitHub Pages on your local machine including Jekyll, Sass, etc. |
52 | | -2. Clone down your fork `git clone [email protected]:yourusername/yourusername.github.io.git` |
53 | | -3. Serve the site and watch for markup/sass changes `jekyll serve` |
54 | | -4. View your website at http://0.0.0.0:4000 |
55 | | -5. Commit any changes and push everything to the master branch of your GitHub user repository. GitHub Pages will then rebuild and serve your website. |
56 | | - |
57 | | -## Moar! |
58 | | - |
59 | | -I've created a more detailed walkthrough, [**Build A Blog With Jekyll And GitHub Pages**](http://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/) over at the Smashing Magazine website. Check it out if you'd like a more detailed walkthrough and some background on Jekyll. :metal: |
60 | | - |
61 | | -It covers: |
62 | | - |
63 | | -- A more detailed walkthrough of setting up your Jekyll blog |
64 | | -- Common issues that you might encounter while using Jekyll |
65 | | -- Importing from Wordpress, using your own domain name, and blogging in your favorite editor |
66 | | -- Theming in Jekyll, with Liquid templating examples |
67 | | -- A quick look at Jekyll 2.0’s new features, including Sass/Coffeescript support and Collections |
68 | | - |
69 | | -## Jekyll Now Features |
70 | | - |
71 | | -✓ Command-line free _fork-first workflow_, using GitHub.com to create, customize and post to your blog |
72 | | -✓ Fully responsive and mobile optimized base theme (**[Theme Demo](http://jekyllnow.com)**) |
73 | | -✓ Sass/Coffeescript support using Jekyll 2.0 |
74 | | -✓ Free hosting on your GitHub Pages user site |
75 | | -✓ Markdown blogging |
76 | | -✓ Syntax highlighting |
77 | | -✓ Disqus commenting |
78 | | -✓ Google Analytics integration |
79 | | -✓ SVG social icons for your footer |
80 | | -✓ 3 http requests, including your avatar |
81 | | - |
82 | | -✘ No installing dependancies |
83 | | -✘ No need to set up local development |
84 | | -✘ No configuring plugins |
85 | | -✘ No need to spend time on theming |
86 | | -✘ More time to code other things ... wait ✓! |
87 | | - |
88 | | -## Questions? |
89 | | - |
90 | | -[Open an Issue](https://github.com/barryclark/jekyll-now/issues/new) and let's chat! |
91 | | - |
92 | | -## Other forkable themes |
93 | | - |
94 | | -You can use the [Quick Start](https://github.com/barryclark/jekyll-now#quick-start) workflow with other themes that are set up to be forked too! Here are some of my favorites: |
95 | | - |
96 | | -- [Hyde](https://github.com/poole/hyde) by MDO |
97 | | -- [Lanyon](https://github.com/poole/lanyon) by MDO |
98 | | -- [mojombo.github.io](https://github.com/mojombo/mojombo.github.io) by Tom Preston-Werner |
99 | | -- [Left](https://github.com/holman/left) by Zach Holman |
100 | | -- [Minimal Mistakes](https://github.com/mmistakes/minimal-mistakes) by Michael Rose |
101 | | -- [Skinny Bones](https://github.com/mmistakes/skinny-bones-jekyll) by Michael Rose |
102 | | - |
103 | | -## Credits |
104 | | - |
105 | | -- [Jekyll](https://github.com/jekyll/jekyll) - Thanks to its creators, contributors and maintainers. |
106 | | -- [SVG icons](https://github.com/neilorangepeel/Free-Social-Icons) - Thanks, Neil Orange Peel. They're beautiful. |
107 | | -- [Solarized Light Pygments](https://gist.github.com/edwardhotchkiss/2005058) - Thanks, Edward. |
108 | | -- [Joel Glovier](http://joelglovier.com/writing/) - Great Jekyll articles. I used Joel's feed.xml in this repository. |
109 | | -- [David Furnes](https://github.com/dfurnes), [Jon Uy](https://github.com/jonuy), [Luke Patton](https://github.com/lkpttn) - Thanks for the design/code reviews. |
110 | | -- [Bart Kiers](https://github.com/bkiers), [Florian Simon](https://github.com/vermluh), [Henry Stanley](https://github.com/henryaj), [Hun Jae Lee](https://github.com/hunjaelee), [Javier Cejudo](https://github.com/javiercejudo), [Peter Etelej](https://github.com/etelej), [Ben Abbott](https://github.com/jaminscript), [Ray Nicholus](https://github.com/rnicholus), [Erin Grand](https://github.com/eringrand), [Léo Colombaro](https://github.com/LeoColomb), [Dean Attali](https://github.com/daattali), [Clayton Errington](https://github.com/cjerrington), [Colton Fitzgerald](https://github.com/coltonfitzgerald), [Trace Mayer](https://github.com/sunnankar) - Thanks for your [fantastic contributions](https://github.com/barryclark/jekyll-now/commits/master) to the project! |
111 | | - |
112 | | -## Contributing |
113 | | - |
114 | | -Issues and Pull Requests are greatly appreciated. If you've never contributed to an open source project before I'm more than happy to walk you through how to create a pull request. |
115 | | - |
116 | | -You can start by [opening an issue](https://github.com/barryclark/jekyll-now/issues/new) describing the problem that you're looking to resolve and we'll go from there. |
117 | | - |
118 | | -I want to keep Jekyll Now as minimal as possible. Every line of code should be one that's useful to 90% of the people using it. Please bear that in mind when submitting feature requests. If it's not something that most people will use, it probably won't get merged. :guardsman: |
| 3 | +The supercoderz blog |
0 commit comments