Skip to content

Commit

Permalink
Initial project setup
Browse files Browse the repository at this point in the history
  • Loading branch information
bitbrain committed Apr 16, 2019
1 parent ecefda4 commit 5410967
Show file tree
Hide file tree
Showing 21 changed files with 300 additions and 21 deletions.
7 changes: 4 additions & 3 deletions .gitignore
@@ -1,4 +1,5 @@
_site/
.sass-cache/
.jekyll-cache/
_site
.sass-cache
.jekyll-metadata
Gemfile.lock

24 changes: 24 additions & 0 deletions 404.html
@@ -0,0 +1,24 @@
---
layout: default
---

<style type="text/css" media="screen">
.container {
margin: 10px auto;
max-width: 600px;
text-align: center;
}
h1 {
margin: 30px 0;
font-size: 4em;
line-height: 1;
letter-spacing: -1px;
}
</style>

<div class="container">
<h1>404</h1>

<p><strong>Page not found :(</strong></p>
<p>The requested page could not be found.</p>
</div>
2 changes: 2 additions & 0 deletions Gemfile
@@ -0,0 +1,2 @@
source "https://rubygems.org"
gemspec
21 changes: 21 additions & 0 deletions LICENSE.txt
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2019 Miguel Gonzalez Sanchez

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.
62 changes: 44 additions & 18 deletions README.md
@@ -1,26 +1,52 @@
![logo](logo.png)
-
A dark theme for Jekyll, inspired by Dash UI for Atom. 🌒
# jekyll-dash

Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.

[![Build Status](https://img.shields.io/travis/bitbrain/braingdx/master.svg?logo=travis&style=flat-square)](https://travis-ci.org/bitbrain/jekyll-dash)
[![license](https://img.shields.io/github/license/bitbrain/braingdx.svg?style=flat-square)](LICENSE.MD)
---
This theme for [Jekyll](https://jekyllrb.com/) has been inspired by [dash-ui](https://atom.io/themes/dash-ui), a dark theme for [Atom](https://atom.io).
To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!

![colors](colors.png)
TODO: Delete this and the text above, and describe your gem

# Features

This Jekyll theme features:
## Installation

- styled blog articles
- syntax highlighting according to the dash ui color standard
- blog comments
- RSS feed
- SEO optimisation
- many customisation options via config
Add this line to your Jekyll site's `Gemfile`:

# Collaboration
```ruby
gem "jekyll-dash"
```

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

```yaml
theme: jekyll-dash
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-dash

## Usage

TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. 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 `jekyll-dash.gemspec` accordingly.

## License

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

Feel free to create pull request or open issues with ideas and bug reports.
50 changes: 50 additions & 0 deletions _config.yml
@@ -0,0 +1,50 @@
title: Your awesome title
author: GitHub User
email: your-email@domain.com
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: false # set to true to show excerpts on the homepage

# jekyll-dash date format
# refer to http://shopify.github.io/liquid/filters/date/ if you want to customize this
jekyll-dash:
date_format: "%b %-d, %Y"

# generate social links in footer
social_links:
twitter: jekyllrb
github: jekyll
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: dash

plugins:
- jekyll-feed
- jekyll-seo-tag
6 changes: 6 additions & 0 deletions _includes/footer.html
@@ -0,0 +1,6 @@
<header class="site-header">

<div class="wrapper">
header
</div>
</header>
11 changes: 11 additions & 0 deletions _includes/head.html
@@ -0,0 +1,11 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
{%- seo -%}
<link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}">
{%- feed_meta -%}
{%- if jekyll.environment == 'production' and site.google_analytics -%}
{%- include google-analytics.html -%}
{%- endif -%}
</head>
5 changes: 5 additions & 0 deletions _includes/header.html
@@ -0,0 +1,5 @@
<footer class="site-footer">
<div class="wrapper">
footer
</div>
</footer>
20 changes: 20 additions & 0 deletions _layouts/default.html
@@ -0,0 +1,20 @@
<!DOCTYPE html>
<html lang="{{ page.lang | default: site.lang | default: "en" }}">

{%- include head.html -%}

<body>

{%- include header.html -%}

<main class="page-content" aria-label="Content">
<div class="wrapper">
{{ content }}
</div>
</main>

{%- include footer.html -%}

</body>

</html>
5 changes: 5 additions & 0 deletions _layouts/page.html
@@ -0,0 +1,5 @@
---
layout: default
---

{{ content }}
5 changes: 5 additions & 0 deletions _layouts/post.html
@@ -0,0 +1,5 @@
---
layout: default
---

{{ content }}
25 changes: 25 additions & 0 deletions _posts/2019-04-16-welcome-to-jekyll.markdown
@@ -0,0 +1,25 @@
---
layout: post
title: "Welcome to Jekyll!"
date: 2019-04-16 08:40:04 +0100
categories: jekyll update
---
You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.

To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.

Jekyll also offers powerful support for code snippets:

{% highlight ruby %}
def print_hi(name)
puts "Hi, #{name}"
end
print_hi('Tom')
#=> prints 'Hi, Tom' to STDOUT.
{% endhighlight %}

Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk].

[jekyll-docs]: https://jekyllrb.com/docs/home
[jekyll-gh]: https://github.com/jekyll/jekyll
[jekyll-talk]: https://talk.jekyllrb.com/
27 changes: 27 additions & 0 deletions _sass/dash.scss
@@ -0,0 +1,27 @@
@charset "utf-8";


$base-font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol" !default;
$base-font-size: 16px !default;
$base-font-weight: 400 !default;
$small-font-size: $base-font-size * 0.875 !default;
$base-line-height: 1.5 !default;

$spacing-unit: 30px !default;

@mixin media-query($device) {
@media screen and (max-width: $device) {
@content;
}
}

@mixin relative-font-size($ratio) {
font-size: $base-font-size * $ratio;
}

// Import partials.
@import
"dash/base",
"dash/layout",
"dash/syntax-highlighting"
;
Empty file added _sass/dash/_base.scss
Empty file.
Empty file added _sass/dash/_layout.scss
Empty file.
Empty file.
18 changes: 18 additions & 0 deletions about.md
@@ -0,0 +1,18 @@
---
layout: page
title: About
permalink: /about/
---

This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/)

You can find the source code for Minima at GitHub:
[jekyll][jekyll-organization] /
[minima](https://github.com/jekyll/minima)

You can find the source code for Jekyll at GitHub:
[jekyll][jekyll-organization] /
[jekyll](https://github.com/jekyll/jekyll)


[jekyll-organization]: https://github.com/jekyll
5 changes: 5 additions & 0 deletions assets/css/style.scss
@@ -0,0 +1,5 @@
---
# Only the main Sass file needs front matter (the dashes are enough)
---

@import "dash";
21 changes: 21 additions & 0 deletions dash.gemspec
@@ -0,0 +1,21 @@
# frozen_string_literal: true

Gem::Specification.new do |spec|
spec.name = "dash"
spec.version = "0.1.0"
spec.authors = ["Miguel Gonzalez Sanchez"]
spec.email = ["miguel-gonzalez@gmx.de"]

spec.summary = "A dark UI theme for Jekyll, inspired by Dash UI for Atom."
spec.homepage = "https://bitbrain.github.io/jekyll-dash"
spec.license = "Apache2"

spec.files = `git ls-files -z`.split("\x0").select { |f| f.match(%r!^(assets|_layouts|_includes|_sass|LICENSE|README)!i) }

spec.add_runtime_dependency "jekyll", "~> 3.5"
spec.add_runtime_dependency "jekyll-feed", "~> 0.9"
spec.add_runtime_dependency "jekyll-seo-tag", "~> 2.1"

spec.add_development_dependency "bundler", "~> 2.0.1"
spec.add_development_dependency "rake", "~> 12.0"
end
7 changes: 7 additions & 0 deletions index.md
@@ -0,0 +1,7 @@
---
# Feel free to add content and custom Front Matter to this file.
# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults

layout: default
---
This is an index page

0 comments on commit 5410967

Please sign in to comment.