Skip to content

Commit 802ebf8

Browse files
Ranga Rao KaranamRanga Rao Karanam
authored andcommitted
removed all other files
1 parent c3b1df0 commit 802ebf8

File tree

81 files changed

+2835
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+2835
-0
lines changed

404.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
layout: center
3+
permalink: /404.html
4+
---
5+
6+
# 404
7+
8+
Sorry, we can't seem to find this page's pixylls.
9+
10+
<div class="mt3">
11+
<a href="{{ site.baseurl }}/" class="button button-blue button-big">Home</a>
12+
<a href="{{ site.baseurl }}/contact/" class="button button-blue button-big">Contact</a>
13+
</div>

CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
pixyll.com

Gemfile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
source 'https://rubygems.org'
2+
3+
# A simple Ruby Gem to bootstrap dependencies for setting up and
4+
# maintaining a local Jekyll environment in sync with GitHub Pages
5+
# https://github.com/github/pages-gem
6+
gem 'github-pages'

LICENSE.txt

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Copyright (c) 2014-2015 John Otander
2+
3+
MIT License
4+
5+
Permission is hereby granted, free of charge, to any person obtaining
6+
a copy of this software and associated documentation files (the
7+
"Software"), to deal in the Software without restriction, including
8+
without limitation the rights to use, copy, modify, merge, publish,
9+
distribute, sublicense, and/or sell copies of the Software, and to
10+
permit persons to whom the Software is furnished to do so, subject to
11+
the following conditions:
12+
13+
The above copyright notice and this permission notice shall be
14+
included in all copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 215 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,215 @@
1+
# Pixyll
2+
3+
[pixyll.com](http://www.pixyll.com)
4+
5+
![Pixyll screenshot](https://cloud.githubusercontent.com/assets/1424573/3847467/134aa236-1e66-11e4-8421-4e8c122118dc.png)
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+
```
21+
$ git clone [email protected]:johnotander/pixyll.git
22+
$ cd pixyll
23+
$ gem install bundler # If you don't have bundler installed
24+
$ bundle install
25+
```
26+
27+
#### Verify your Jekyll version
28+
29+
It's important to also check your version of Jekyll since this project uses Native Sass which
30+
is [only supported by 2.0+](http://jekyllrb.com/news/2014/05/06/jekyll-turns-2-0-0/).
31+
32+
### Fork, then clone
33+
34+
Fork the repo, and then clone it so you've got the code locally.
35+
36+
### Modify the `_config.yml`
37+
38+
The `_config.yml` located in the root of the Pixyll directory contains all of the configuration details
39+
for the Jekyll site. The defaults are:
40+
41+
```yml
42+
# Site settings
43+
title: Pixyll
44+
45+
author: John Otander
46+
description: "A simple, beautiful theme for Jekyll that emphasizes content rather than aesthetic fluff."
47+
baseurl: ""
48+
url: "http://pixyll.com"
49+
50+
# Build settings
51+
markdown: kramdown
52+
permalink: pretty
53+
paginate: 3
54+
```
55+
56+
### Jekyll Serve
57+
58+
Then, start the Jekyll Server. I always like to give the `--watch` option so it updates the generated HTML when I make changes.
59+
60+
```
61+
$ jekyll serve --watch
62+
```
63+
64+
Now you can navigate to `localhost:4000` in your browser to see the site.
65+
66+
### Using Github Pages
67+
68+
You can host your Jekyll site for free with Github Pages. [Click here](https://pages.github.com/) for more information.
69+
70+
#### A configuration tweak if you're using a gh-pages sub-folder
71+
72+
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.
73+
74+
This will require you to modify the `_config.yml` like so:
75+
76+
```yml
77+
# Site settings
78+
title: Repo Name
79+
80+
author: John Otander
81+
description: "Repo description"
82+
baseurl: "/repo-name"
83+
url: "http://github-username.github.io"
84+
85+
# Build settings
86+
markdown: kramdown
87+
permalink: pretty
88+
paginate: 3
89+
```
90+
91+
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 ''`.
92+
93+
##### If you don't want the header to link back to the root url
94+
95+
You will also need to tweak the header include `/{{ site.baseurl }}`:
96+
97+
```html
98+
<header class="site-header px2 px-responsive">
99+
<div class="mt2 wrap">
100+
<div class="measure">
101+
<a href="{{ site.url }}/{{ site.baseurl }}">{{ site.title }}</a>
102+
<nav class="site-nav right">
103+
{% include navigation.html %}
104+
</nav>
105+
</div>
106+
</div>
107+
</header>
108+
```
109+
110+
A relevant Jekyll Github Issue: <https://github.com/jekyll/jekyll/issues/332>
111+
112+
### Contact Form
113+
114+
The contact form uses <http://formspree.io>. It will require you to fill the form out and submit it once, before going live, to confirm your email.
115+
116+
More setup instructions and advanced options can be found at [http://formspree.io](http://formspree.io/)
117+
118+
### Disqus
119+
120+
To configure Disqus, set up a [Disqus site](https://disqus.com/admin/create/) with the same name as your site. Then, in `_config.yml`, edit the `disqus_shortname` value to enable Disqus.
121+
122+
### Customizing the CSS
123+
124+
All variables can be found in the `_sass/_variables.scss` file, toggle these as you'd like to change the look and feel of Pixyll.
125+
126+
### Page Animation
127+
128+
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`.
129+
130+
### AnchorJS
131+
132+
[AnchorJS](https://github.com/bryanbraun/anchorjs): _A JavaScript utility for adding deep anchor links to existing page content. AnchorJS is lightweight, accessible, and has no dependencies._ You can turn it on by toggling `enable_anchorjs`. Because it offers many ways for customization, tweaks should be done in `_includes/footer.html`. Default settings after turning AnchorJS on are:
133+
134+
```html
135+
<script>
136+
anchors.options.visible = 'always';
137+
anchors.add('article h2, article h3, article h4, article h5, article h6');
138+
</script>
139+
```
140+
141+
See [documentation](http://bryanbraun.github.io/anchorjs/#basic-usage) for more options.
142+
143+
### Put in a Pixyll Plug
144+
145+
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.
146+
147+
### Web analytics and search engines
148+
149+
You can measure visits to your website either by using [Google Analytics](https://www.google.com/analytics/) tracking embed or the more advanced [Google Tag Manager](https://www.google.com/analytics/tag-manager/) container.
150+
* For Google Analytics set up the value for `google_analytics`, it should be something like `google_analytics: UA-XXXXXXXX-X`.
151+
* For Google Tag Manager set up the value for `google_tag_manager`, it should be something like: `google_tag_manager: GTM-XXXXX`.
152+
* _Do not_ set both of above methods because this will cause conflicts and skew your reporting data.
153+
* Remember that you need to properly configure the GTM container in its admin panel if you want it to work. More info is available in [GTM's docs](https://www.google.com/analytics/tag-manager/resources/).
154+
155+
Your website is, by default, set to be allowed for crawling and indexing by search engines. (Unless you made yourself a custom robots.txt file). You can use front matter settings on each page to control how search engines will it. Sometimes you may want to exclude a particular page from indexing or forbid Google to store a copy of your page in its cache. It is up to you. Use the `meta_robots` frontmatter key and assign values based on [this table](https://developers.google.com/webmasters/control-crawl-index/docs/robots_meta_tag?hl=en#valid-indexing--serving-directives). Some examples:
156+
157+
```yaml
158+
# exclude page from index
159+
meta_robots: noindex
160+
161+
# allow indexing, disallow caching
162+
meta_robots: noarchive
163+
164+
# allow indexing, disallow crawling links
165+
meta_robots: nofollow
166+
167+
# disallow indexing, follow links
168+
meta_robots: noindex,follow
169+
```
170+
171+
In order to get more information about your website's status in search engines, you can register it in [Google Search Console](https://www.google.com/webmasters/tools/home) and/or [Bing Webmaster Tools](http://www.bing.com/toolbox/webmaster). Both these tools will ask you to authorize your website with them and there are couple of ways to do that. Pixyll supports verification via meta tags - just fill in values for `google_verification` and/or `bing_verification` in `_config.yml`, the verification strings and meta tags will then be added automatically.
172+
173+
If search engine optimization is your thing, you can also set up `meta_description` values for each page/post. By default Pixyll uses `summary` to populate the `<meta name="description" content="...">` tag and falls back to `description` from `_config.yml` if `summary` is not present in page/post's front matter. The `summary` is also used for generating Open Graph tags. Why would you want to use a dedicated variable for meta description? Because character limit to properly display this description in search results (as a snippet) is way smaller than in Open Graph. It is recommended to keep it at 155-160 characters, for more in-depth info read [this article](https://moz.com/blog/i-cant-drive-155-meta-descriptions-in-2015).
174+
175+
And lastly - if you happen to write in language other than English be sure to change `og_locale` in `_config.yml` to reflect it.
176+
177+
### Enjoy
178+
179+
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.
180+
181+
## Upgrading Pixyll
182+
183+
Pixyll is always being improved by its users, so sometimes one may need to upgrade.
184+
185+
#### Ensure there's an upstream remote
186+
187+
If `git remote -v` doesn't have an upstream listed, you can do the following to add it:
188+
189+
```
190+
git remote add upstream https://github.com/johnotander/pixyll.git
191+
```
192+
193+
#### Pull in the latest changes
194+
195+
```
196+
git pull upstream master
197+
```
198+
199+
There may be merge conflicts, so be sure to fix the files that git lists if they occur. That's it!
200+
201+
## Thanks to the following
202+
203+
* [BASSCSS](http://basscss.com)
204+
* [Jekyll](http://jekyllrb.com)
205+
* [Refills](http://refills.bourbon.io/)
206+
* [Solarized](http://ethanschoonover.com/solarized)
207+
* [Animate.css](http://daneden.github.io/animate.css/)
208+
209+
## Contributing
210+
211+
1. Fork it
212+
2. Create your feature branch (`git checkout -b my-new-feature`)
213+
3. Commit your changes (`git commit -am 'Add some feature'`)
214+
4. Push to the branch (`git push origin my-new-feature`)
215+
5. Create new Pull Request

Rakefile

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
drafts_dir = '_drafts'
2+
posts_dir = '_posts'
3+
4+
# rake post['my new post']
5+
desc 'create a new post with "rake post[\'post title\']"'
6+
task :post, :title do |t, args|
7+
if args.title
8+
title = args.title
9+
else
10+
puts "Please try again. Remember to include the filename."
11+
end
12+
mkdir_p "#{posts_dir}"
13+
filename = "#{posts_dir}/#{Time.now.strftime('%Y-%m-%d')}-#{title.downcase.gsub(/[^\w]+/, '-')}.md"
14+
puts "Creating new post: #{filename}"
15+
File.open(filename, "w") do |f|
16+
f << <<-EOS.gsub(/^ /, '')
17+
---
18+
layout: post
19+
title: #{title}
20+
date: #{Time.new.strftime('%Y-%m-%d %H:%M')}
21+
categories:
22+
---
23+
24+
EOS
25+
end
26+
27+
# Uncomment the line below if you want the post to automatically open in your default text editor
28+
# system ("#{ENV['EDITOR']} #{filename}")
29+
end
30+
31+
# usage: rake draft['my new draft']
32+
desc 'create a new draft post with "rake draft[\'draft title\']"'
33+
task :draft, :title do |t, args|
34+
if args.title
35+
title = args.title
36+
else
37+
puts "Please try again. Remember to include the filename."
38+
end
39+
mkdir_p "#{drafts_dir}"
40+
filename = "#{drafts_dir}/#{title.downcase.gsub(/[^\w]+/, '-')}.md"
41+
puts "Creating new draft: #{filename}"
42+
File.open(filename, "w") do |f|
43+
f << <<-EOS.gsub(/^ /, '')
44+
---
45+
layout: post
46+
title: #{title}
47+
date: #{Time.new.strftime('%Y-%m-%d %H:%M')}
48+
categories:
49+
---
50+
51+
EOS
52+
end
53+
54+
# Uncomment the line below if you want the draft to automatically open in your default text editor
55+
# system ("#{ENV['EDITOR']} #{filename}")
56+
end
57+
58+
desc 'preview the site with drafts'
59+
task :preview do
60+
puts "## Generating site"
61+
puts "## Stop with ^C ( <CTRL>+C )"
62+
system "jekyll serve --watch --drafts"
63+
end
64+
65+
desc 'list tasks'
66+
task :list do
67+
puts "Tasks: #{(Rake::Task.tasks - [Rake::Task[:list]]).join(', ')}"
68+
puts "(type rake -T for more detail)\n\n"
69+
end

0 commit comments

Comments
 (0)