Skip to content

Commit 0cd3300

Browse files
committed
u
1 parent 9b6eb8a commit 0cd3300

40 files changed

Lines changed: 1375 additions & 532 deletions

.gitignore

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,10 @@
1-
_site
1+
_site
2+
.DS_Store
3+
.jekyll
4+
.jekyll-metadata
5+
.bundle
6+
.sass-cache
7+
Gemfile
8+
Gemfile.lock
9+
node_modules
10+
package.json

404.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
layout: page
3+
title: 404 - Page not found
4+
---
5+
6+
Sorry, we can't find that page that you're looking for. You can try again by going [back to the homepage]({{ site.baseurl }}/).
7+
8+
[<img src="{{ site.baseurl }}/images/404.jpg" alt="Constructocat by https://github.com/jasoncostello" style="width: 400px;"/>]({{ site.baseurl }}/)

CNAME

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

LICENSE

Lines changed: 0 additions & 17 deletions
This file was deleted.

LICENSE.txt

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

README.md

Lines changed: 124 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,137 @@
1-
# Simply Grey
2-
Simply Grey is a nice, easy on the eyes Jekyll theme that makes great use of grey colours.
1+
# Jekyll-Mono
32

4-
![Screenshot of Simply Grey](http://i.imgur.com/sKpj8Oz.png)
3+
**Jekyll-Mono** is a simple and elegant GitHub Profile cum Blog theme based on Barry Clark's [Jekyll-Now](https://github.com/barryclark/jekyll-now). It's a result of my attempt to learn **Jekyll** and create a minimalistic theme to put up my CV alongwith some blog posts.
54

6-
## Installation
7-
There are a few requirements to using and installing the Simply Grey theme.
5+
It is crafted with 💙 by [Akshay Agarwal](https://github.com/AkshayAgarwal007).
86

9-
1. You must have Jekyll installed. If you have no done this, do it by executing the following code.
10-
`gem install jekyll`
7+
![Jekyll-Mono Home Page](/images/ss.png)
118

12-
2. You must have git installed. If you do not have this, install it on your system by using your package manager. For example, in Debian, type
13-
`sudo apt-get install git`
149

15-
Once you have done this, installation is pretty easy.
10+
## What is Jekyll?
1611

17-
Simply clone the repository
12+
It is a static site generator. It takes your content written in Markdown, passes it through your templates and spits it out as a complete static website, ready to be served using GitHub pages for free.
13+
Because your entire blog is static it serves and perform faster. It consumes less web resources namely memory and I/O.
1814

19-
`git clone https://github.com/liamsymonds/simplygrey-jekyll.git`
15+
## Getting Started
2016

21-
and serve the blog up so people can see it
17+
Let's quickly set up your new blog in a matter of minutes.
2218

23-
`cd simplygrey-jekyll; jekyll serve`
19+
### Fork this repository
2420

25-
## Configuring SimplyGrey
26-
The SimplyGrey theme is actually very easy to configure.
21+
Hit the “Fork” button in the top-right corner of the repository to fork a copy of this theme to your GitHub account and rename it to **yourusername.github.io** and then visit https://yourusername.github.io and you'll be able to see your newly created blog using Jekyll-Mono.
2722

28-
### Adding more links to the navigation bar
29-
1. Open the _config.yml file
30-
2. Add some more values to the urls hash like the others that already exist there.
23+
### Customise Jekyll-Mono
3124

32-
### Changing the site name
33-
1. Open the _config.yml file
34-
2. Change the site name
25+
So now your blog is live with its default settings. Let's customise it now.
3526

36-
### Changing the logo/picture image
37-
1. Drop a 75x75 image into the img directory.
27+
Edit the _config.yml and enter your site name and description. You can easily turn on Google Analytics tracking, Disqus commenting and cool loking social icons here too.
28+
29+
Jekyll-Mono also comes with the option of setting up the color scheme of your blog. You can do this by editing _variables.scss that lies inside the _sass folder. You can change the main theme color by simply replacing the current hex color value of `$mono` with the one of your choice. A few main theme sample colors are included in there as comments. Apart from the main theme color you can also change the header link color, navbar hover color, hyperlink color as well as the color of the various headings.
30+
31+
A look at the customisations you can do with _variable.scss
32+
33+
```
34+
// Main theme colors
35+
// Some cool main theme colors(violet:#8476ad;blue:#5cacee;red:#ff7373,#ff6f69;green:#6acf64,#2ddbb3;orange:#ffa268)
36+
37+
$mono-color:#8476ad; // main theme color(header, links, footer icons, buttons, post-title)
38+
$hl-color: $darkGray; // header link color (author name and posted on date) for blog post meta
39+
$navbar-hover-color:$gray; // navbar hover color (site name and navbar links hover color)
40+
$link-color: $darkerGray; // normal hyperlink color other than the ones above.
41+
42+
43+
// Heading colors
44+
// You can play around with these too!
45+
$h1-color: $mono-color;
46+
$h2-color: $mono-color;
47+
$h3-color: $darkerGray;
48+
$h4-color: $gray;
49+
```
50+
Have a look at Jekyll-Mono with four different main theme colors.
51+
52+
![Jekyll Mono in 4 different colors](/images/ss-color.png)
53+
54+
Finally you need to set up your avatar. Pick up your avatar, resize it to 220x220px simply using paint or any editor of your choice and upload it to the images folder. Now open _variables.scss, you'll see something like this `$avatar: "/images/avatar.jpg";`. Here change the avatar.jpg to what you have uploaded just now.
55+
56+
57+
### Start Blogging
58+
59+
Publish your first blog post by editing /_posts/2016-03-06-Eternal-Lorem-Ipsum.md. [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) might come in handy while writing your blog posts in Markdown. If you are not comfortable with writing in Markdown you can use [Prose](http://prose.io/) for writing your blog posts. [This](https://developmentseed.org/blog/2012/june/25/prose-a-content-editor-for-github/s) will help you in setting up prose.
60+
61+
![Post](/images/post.PNG)
62+
63+
To create a post just click on create new file button in /_posts/. Create a new file with the following naming convention: **year-month-day-title.md**. Also make sure to include the front-matter at the top of each new blog post.
64+
65+
You can see the front matter at the top of /_posts/2016-03-06-Eternal-Lorem-Ipsum.md. It looks something like this. You have to change the title and author according to your post. The layout will remain the same.
66+
67+
```
68+
---
69+
layout: post
70+
title: The Eternal Lorem Ipsum Placeholder Text Here
71+
author: Author Name
72+
---
73+
74+
```
75+
76+
### About and Projects Page
77+
78+
In the parent folder you'll find about.md and projects.md. These are templates for helping you to set up your biodata/CV and projects that will be available at yourusername.github.io/about and yourusername.github.io/projects respectively. Again you can edit it in Markdown on GitHub or using Prose as per your choice.
79+
80+
81+
## Demo
82+
83+
You can see the live demo of this theme at http://akshayagarwal007.github.io/Jekyll-Mono/
84+
85+
## Local Development
86+
87+
For setting up your development environment you can follow the official Jekyll [Documentation](https://jekyllrb.com/docs/installation/). It's a little bit complicated for Windows users. Let's see how it's done on windows:
88+
89+
1. **Install Chocolatey**. **[Chocolatey](https://chocolatey.org)** is a package manager for windows. It's awesome.
90+
Open a command propmt with administrator access. Paste this. Hit Enter and restart the command prompt.
91+
92+
```
93+
@powershell -NoProfile -ExecutionPolicy Bypass -Command "iex ((new-object net.webclient).DownloadString('https://chocolatey.org/install.ps1'))" && SET PATH=%PATH%;%ALLUSERSPROFILE%\chocolatey\bin
94+
95+
```
96+
97+
2. **Install Ruby** : In your command prompt type `choco install ruby -y`.
98+
Hit Enter. After installation restart the cmd with administrator privileges.
99+
100+
3. **Install Jekyll/Sass (plug-ins used by GitHub Pages)**: `gem install github-pages`
101+
102+
4. **Clone your fork of Jekyll-Mono** `git clone https://github.com/yourusername/yourusername.github.io.git`
103+
104+
5. **Serve the site** by `jekyll serve`. It regenerates itself after any changes has been made.
105+
106+
6. **View your site** at http://127.0.0.1:4000/
107+
108+
7. If you make any changes to _config.yml you'll need to rebuild the site using `jekyll build` and then again a `jekyll serve` to serve it. You'll need to do a rebuild only if you want to see the changes locally, else you can simply commit your changes and push them to your GitHub repo, GitHub pages will rebuild and serve your website.
109+
110+
## Credits
111+
112+
* [Barry Clark](https://github.com/barryclark) for creating [Jekyll-Now](https://github.com/barryclark/jekyll-now) on which this theme is based.
113+
* [Manoela Ilic](https://github.com/crnacura) of Codrops for writing awesome articles on web design.
114+
* [David Miller](https://github.com/davidtmiller) of Blackrock Digital for making awesome open source themes.
115+
* [Jekyll](https://github.com/jekyll/jekyll) - Thanks to its creator and contributors.
116+
* [Font-Awesome](http://fontawesome.io) - Thanks to its creator and contributors.
117+
118+
## Contributing
119+
120+
* Found a bug? Report it on GitHub [Issues](https://github.com/AkshayAgarwal007/Jekyll-Mono/issues) and include a code sample.
121+
* [Fork](https://github.com/AkshayAgarwal007/Jekyll-Mono/fork) the repository and start your own blog using it and let me know about it so that I can include a reference to it here. Probably the best way you can contribute :)
122+
* If you find anything that's wrong or want to talk to me about anything related to this theme or want to contribute in any way, please feel free to [mail me](mailto:[email protected]).
123+
124+
## License
125+
126+
Jekyll-Mono is licensed under [MIT](https://github.com/AkshayAgarwal007/Jekyll-Mono/blob/master/LICENSE.txt).
127+
128+
129+
130+
131+
132+
133+
134+
135+
136+
137+

_config.yml

Lines changed: 81 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,81 @@
1-
name: Simply Grey
2-
markdown: redcarpet
3-
highlighter: pygments
4-
github: https://www.github.com/liamsymonds
5-
about: I am an independent developer from the sunny UK. I dabble in Ruby, play in C and I'm an avid systems administrator.
6-
urls:
7-
- text: github
8-
url: https://github.com/liamsymonds
9-
baseurl: '/simplygrey-jekyll'
1+
#
2+
# This file contains configuration flags to customize your site
3+
#
4+
5+
# Name of your site (displayed in the header)
6+
name: Your Username
7+
8+
# Short bio or description (displayed in the header)
9+
description: Programmer From Somewhere On Earth
10+
11+
12+
#
13+
# Flags below are optional
14+
#
15+
16+
# Includes an icon in the footer for each username you enter
17+
footer-links:
18+
dribbble:
19+
20+
facebook:
21+
flickr:
22+
github: AkshayAgarwal007
23+
instagram:
24+
linkedin: akshay-agarwal-782018a4
25+
pinterest:
26+
rss: # just type anything here for a working RSS icon
27+
twitter:
28+
stackoverflow: # your stackoverflow profile, e.g. "users/3807565/akshay"
29+
youtube: # channel/<your_long_string> or user/<user-name>
30+
googleplus: # anything in your profile username that comes after plus.google.com/
31+
32+
33+
# Enter your Disqus shortname (not your username) to enable commenting on posts
34+
# You can find your shortname on the Settings page of your Disqus account
35+
disqus:
36+
37+
# Enter your Google Analytics web tracking code (e.g. UA-2110908-2) to activate tracking
38+
google_analytics:
39+
40+
# Your website URL (e.g. http://akshayagarwal007.github.io)
41+
# Used for Sitemap.xml and your RSS feed
42+
url:
43+
44+
# If you're hosting your site at a Project repository on GitHub pages
45+
# (http://yourusername.github.io/repository-name)
46+
# and NOT your User repository (http://yourusername.github.io)
47+
# then add in the baseurl here, like this: "/repository-name"
48+
baseurl: ""
49+
50+
#
51+
# !! You don't need to change any of the configuration flags below !!
52+
#
53+
54+
permalink: /:title/
55+
56+
# Jekyll 3 now only supports Kramdown for Markdown
57+
kramdown:
58+
# Use GitHub flavored markdown, including triple backtick fenced code blocks
59+
input: GFM
60+
# Jekyll 3 and GitHub Pages now only support rouge for syntax highlighting
61+
syntax_highlighter: rouge
62+
syntax_highlighter_opts:
63+
# Use existing pygments syntax highlighting css
64+
css_class: 'highlight'
65+
66+
# Set the Sass partials directory, as we're using @imports
67+
sass:
68+
style: :expanded # You might prefer to minify using :compressed
69+
70+
# Use the following plug-ins
71+
gems:
72+
- jekyll-sitemap # Create a sitemap using the official Jekyll sitemap gem
73+
- jekyll-feed # Create an Atom feed using the official Jekyll feed gem
74+
75+
# Exclude these files from your production _site
76+
exclude:
77+
- Gemfile
78+
- Gemfile.lock
79+
- LICENSE
80+
- README.md
81+
- CNAME

_includes/analytics.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{% if site.google_analytics %}
2+
<!-- Google Analytics -->
3+
<script>
4+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
5+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
6+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
7+
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
8+
9+
ga('create', '{{ site.google_analytics }}', 'auto');
10+
ga('send', 'pageview', {
11+
'page': '{{ site.baseurl }}{{ page.url }}',
12+
'title': '{{ page.title | replace: "'", "\\'" }}'
13+
});
14+
</script>
15+
<!-- End Google Analytics -->
16+
{% endif %}

_includes/disqus.html

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{% if site.disqus %}
2+
<div class="comments">
3+
<div id="disqus_thread"></div>
4+
<script type="text/javascript">
5+
6+
var disqus_shortname = '{{ site.disqus }}';
7+
8+
(function() {
9+
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
10+
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
11+
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
12+
})();
13+
14+
</script>
15+
<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
16+
</div>
17+
{% endif %}

_includes/meta.html

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<meta charset="utf-8" />
2+
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
3+
<meta http-equiv='X-UA-Compatible' content='IE=edge'>
4+
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1.0'>
5+
6+
{% if page.excerpt %}
7+
<meta name="description" content="{{ page.excerpt| strip_html }}" />
8+
<meta property="og:description" content="{{ page.excerpt| strip_html }}" />
9+
{% else %}
10+
<meta name="description" content="{{ site.description }}">
11+
<meta property="og:description" content="{{ site.description }}" />
12+
{% endif %}
13+
<meta name="author" content="{{ site.name }}" />
14+
15+
{% if page.title %}
16+
<meta property="og:title" content="{{ page.title }}" />
17+
<meta property="twitter:title" content="{{ page.title }}" />
18+
{% endif %}

0 commit comments

Comments
 (0)