Skip to content

Commit

Permalink
Testing new template.
Browse files Browse the repository at this point in the history
  • Loading branch information
amela committed Jan 8, 2020
1 parent 25fedd9 commit b69ce00
Show file tree
Hide file tree
Showing 27 changed files with 1,361 additions and 2 deletions.
34 changes: 34 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Page Not Found
---
<!DOCTYPE html>
<html lang="en">
<head>
{%- include head.html -%}
<style>
h2 {
font-feature-settings: "lnum";
background-color: #ddd;
width: 140px;
height: 140px;
border-radius: 100%;
display: flex;
justify-content: center;
align-items: center
}
body {
display: flex;
justify-content: center;
align-items: center;
flex-direction: column;
font-size: 20px;
height: 80vh;
}
p {text-align: center; line-height: 2em;}
</style>
</head>
<body>
<h2>404</h2>
<p>Page not found.</p>
</body>
</html>
4 changes: 4 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# frozen_string_literal: true

source "https://rubygems.org"
gemspec
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2019 Samarjeet

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
146 changes: 146 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
# plainwhite

Simplistic jekyll portfolio-style theme for writers.

**Demo**: [thelehhman.com](https://thelehhman.com)

![plainwhite theme preview](/screenshot.png)

## Installation on Github Pages

Add this line to your site's `_config.yml`:

```yaml
remote_theme: thelehhman/plainwhite-jekyll
```
## Installation
Add this line to your Jekyll site's `Gemfile`:

```ruby
gem "plainwhite"
```

And add this line to your Jekyll site's `_config.yml`:

```yaml
theme: plainwhite
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install plainwhite

## Usage

The "plainwhite" key in \_config.yml is used to customize the theme data.

```yaml
plainwhite:
name: Adam Denisov
tagline: Developer. Designer
date_format: "%b %-d, %Y"
social_links:
twitter: thelehhman
github: thelehhman
linkedIn: in/thelehhman # format: locale/username
```

**Updating Placeholder Image**

The placeholder portfolio image can be replaced by the desired image by placing it as `assets/portfolio.png` in your jekyll website.

**Comments (Disqus)**

Comments on posts can be enabled by specifying your disqus_shortname under plainwhite in `_config.yml`. For example,

```yaml
plainwhite:
disqus_shortname: games
```

**Google Analytics**

It can be enabled by specifying your analytics id under plainwhite in `_config.yml`

```yaml
plainwhite:
analytics_id: "< YOUR ID >"
```

**Sitemap**

It can be toggled by the following line to under plainwhite in `_config.yml`

```yaml
plainwhite:
sitemap: true
```

**Excerpts**

Excerpts can be enabled by adding the following line to your `_config.yml`

```yaml
show_excerpts: true
```

**Layouts**

- Home
- Page
- Post

**Navigation**

Navigation can be enabled by adding the following line to your `_config.yml`

```yaml
plainwhite:
navigation:
- title: My Work
url: "/my-work"
- title: Resume
url: "/resume"
```

**Multiline tagline**

Tagline can be multiline in this way

```yaml
plainwhite:
tagline: |
First Line.
Second Line.
Third Line.
```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/thelehhman/plainwhite-jekyll. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## Development

To set up your environment to develop this theme, run `bundle install`.

Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
To add a custom directory to your theme-gem, please edit the regexp in `plainwhite.gemspec` accordingly.

## License

The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## More themes

- [Texture](https://github.com/thelehhman/texture)
57 changes: 56 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
@@ -1 +1,56 @@
remote_theme: thelehhman/plainwhite-jekyll
title: Your awesome title
author: GitHub User
email: [email protected]
description: > # this means to ignore newlines until "show_exerpts:"
Write an awesome description for your new site here. You can edit this
line in _config.yml. It will appear in your document head meta (for
Google search results) and in your feed.xml site description.
show_excerpts: true # set to true to show excerpts on the homepage

# Minima date format
# refer to http://shopify.github.io/liquid/filters/date/ if you want to customize this
sass:
sass_dir: _sass
plainwhite:
name: Adam Denisov
tagline: Developer. Designer
date_format: "%b %-d, %Y"
sitemap: true # set to true to generate sitemap.xml content

# generate social links in footer
social_links:
twitter: thelehhman
github: thelehhman
linkedIn: in/thelehhman
rss: rss
# dribbble: jekyll
# facebook: jekyll
# flickr: jekyll
# instagram: jekyll
# linkedin: jekyll
# pinterest: jekyll
# youtube: jekyll
# youtube_channel: UC8CXR0-3I70i1tfPg1PAE1g
# youtube_channel_name: CloudCannon
# telegram: jekyll
# googleplus: +jekyll
# microdotblog: jekyll

# Mastodon instances
# mastodon:
# - username: jekyll
# instance: example.com
# - username: jekyll2
# instance: example.com

# If you want to link only specific pages in your header, uncomment
# this and add the path to the pages in order as they should show up
#header_pages:
# - about.md

# Build settings
theme: plainwhite

plugins:
- jekyll-seo-tag
# - jekyll-feed
7 changes: 7 additions & 0 deletions _includes/head.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<link href="https://fonts.googleapis.com/css?family=Merriweather:300|Raleway:400,700" rel="stylesheet">
<link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}">
<title>{{ page.title | default: site.title }}</title>
{% seo %}
68 changes: 68 additions & 0 deletions _layouts/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<!DOCTYPE html>
<html lang="en">
<head>
{%- include head.html -%}
</head>
<body>
<main class="container">
<section class="about">
<a href="/"><img src="{{ "/assets/portfolio.png" | relative_url }}" alt="{{ site.plainwhite.name }}"></a>
<h2 id="title">
<a href="/">{{ site.plainwhite.name }}</a>
</h2>
<p class="tagline">{{ site.plainwhite.tagline }}</p>
<ul class="social">
{%- if site.plainwhite.social_links.github -%}
<a href="https://github.com/{{ site.plainwhite.social_links.github }}">
<li>
<i class="icon-github-circled"></i>
</li>
</a>
{%- endif -%}
{%- if site.plainwhite.social_links.linkedIn -%}
<a href="https://www.linkedin.com/{{ site.plainwhite.social_links.linkedIn }}">
<li>
<i class="icon-linkedin-squared"></i>
</li>
</a>
{%- endif -%}
{%- if site.plainwhite.social_links.twitter -%}
<a href="https://twitter.com/{{ site.plainwhite.social_links.twitter }}">
<li>
<i class="icon-twitter-squared"></i>
</li>
</a>
{%- endif -%}
</ul>

{%- if site.plainwhite.navigation -%}
<nav class="navigation">
<ul>
{% for link in site.plainwhite.navigation %}
<li>
<a href="{{ link.url }}">{{ link.title }}</a>
</li>
{% endfor %}
</ul>
</nav>
{%- endif -%}

<p>&copy;
{{ "now" | date: "%Y" }}</p>
</section>
<section class="content">
{{ content }}
</section>
</main>
{%- if site.plainwhite.analytics_id -%}
<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.plainwhite.analytics_id }}"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());

gtag('config', '{{ site.plainwhite.analytics_id }}');
</script>
{%- endif -%}
</body>
</html>
45 changes: 45 additions & 0 deletions _layouts/home.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
layout: default
---

{%- if page.title -%}
<h1 class="page-heading">{{ page.title }}</h1>
{%- endif -%}

{{ content }}

{%- if site.posts.size > 0 -%}
<ul class="posts">
<li>
<h1 id="posts-label">posts</h1>
</li>

{%- for post in site.posts -%}
<li>
{%- assign date_format = site.plainwhite.date_format | default: "%b %-d, %Y" -%}
<a class="post-link" href="{{ post.url | relative_url }}">
<h2 class="post-title">{{ post.title | escape }}</h2>
</a>
<div class="post-meta">
<ul class="post-categories">
{%- for tag in post.categories -%}
<li>{{ tag }}</li>
{%- endfor -%}
</ul>
<div class="post-date">
<i class="icon-calendar"></i>
{{ post.date | date: date_format }}</div>
</div>
<div class="post">
{%- if site.show_excerpts -%}
{{ post.excerpt }}
{%- endif -%}
</div>
</li>
{%- endfor -%}
</ul>

<!-- <p class="feed-subscribe"><svg class="svg-icon orange">
<use xlink:href="{{ '/assets/minima-social-icons.svg#rss' | relative_url }}"></use>
</svg><a href="{{ "/feed.xml" | relative_url }}">Subscribe</a></p> -->
{%- endif -%}
Loading

0 comments on commit b69ce00

Please sign in to comment.