diff --git a/.gitignore b/.gitignore index 2ca86829..fd987304 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ -_site/ -.sass-cache/ -.jekyll-cache/ +_site +.sass-cache .jekyll-metadata +Gemfile.lock + diff --git a/404.html b/404.html new file mode 100644 index 00000000..c472b4ea --- /dev/null +++ b/404.html @@ -0,0 +1,24 @@ +--- +layout: default +--- + + + +
+

404

+ +

Page not found :(

+

The requested page could not be found.

+
diff --git a/Gemfile b/Gemfile new file mode 100644 index 00000000..3be9c3cd --- /dev/null +++ b/Gemfile @@ -0,0 +1,2 @@ +source "https://rubygems.org" +gemspec diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 00000000..5da8e18e --- /dev/null +++ b/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. diff --git a/README.md b/README.md index 67df1d95..0511f8df 100644 --- a/README.md +++ b/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. diff --git a/_config.yml b/_config.yml new file mode 100644 index 00000000..6b502eb5 --- /dev/null +++ b/_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 diff --git a/_includes/footer.html b/_includes/footer.html new file mode 100644 index 00000000..a19f2450 --- /dev/null +++ b/_includes/footer.html @@ -0,0 +1,6 @@ +
+ +
+ header +
+
diff --git a/_includes/head.html b/_includes/head.html new file mode 100644 index 00000000..06811779 --- /dev/null +++ b/_includes/head.html @@ -0,0 +1,11 @@ + + + + + {%- seo -%} + + {%- feed_meta -%} + {%- if jekyll.environment == 'production' and site.google_analytics -%} + {%- include google-analytics.html -%} + {%- endif -%} + diff --git a/_includes/header.html b/_includes/header.html new file mode 100644 index 00000000..7d5baa06 --- /dev/null +++ b/_includes/header.html @@ -0,0 +1,5 @@ + diff --git a/_layouts/default.html b/_layouts/default.html new file mode 100644 index 00000000..58e141b7 --- /dev/null +++ b/_layouts/default.html @@ -0,0 +1,20 @@ + + + + {%- include head.html -%} + + + + {%- include header.html -%} + +
+
+ {{ content }} +
+
+ + {%- include footer.html -%} + + + + diff --git a/_layouts/page.html b/_layouts/page.html new file mode 100644 index 00000000..5e711268 --- /dev/null +++ b/_layouts/page.html @@ -0,0 +1,5 @@ +--- +layout: default +--- + +{{ content }} diff --git a/_layouts/post.html b/_layouts/post.html new file mode 100644 index 00000000..5e711268 --- /dev/null +++ b/_layouts/post.html @@ -0,0 +1,5 @@ +--- +layout: default +--- + +{{ content }} diff --git a/_posts/2019-04-16-welcome-to-jekyll.markdown b/_posts/2019-04-16-welcome-to-jekyll.markdown new file mode 100644 index 00000000..39a13b11 --- /dev/null +++ b/_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/ diff --git a/_sass/dash.scss b/_sass/dash.scss new file mode 100644 index 00000000..4d914a3c --- /dev/null +++ b/_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" +; diff --git a/_sass/dash/_base.scss b/_sass/dash/_base.scss new file mode 100644 index 00000000..e69de29b diff --git a/_sass/dash/_layout.scss b/_sass/dash/_layout.scss new file mode 100644 index 00000000..e69de29b diff --git a/_sass/dash/_syntax-highlighting.scss b/_sass/dash/_syntax-highlighting.scss new file mode 100644 index 00000000..e69de29b diff --git a/about.md b/about.md new file mode 100644 index 00000000..8b4e0b28 --- /dev/null +++ b/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 diff --git a/assets/css/style.scss b/assets/css/style.scss new file mode 100644 index 00000000..b8247436 --- /dev/null +++ b/assets/css/style.scss @@ -0,0 +1,5 @@ +--- +# Only the main Sass file needs front matter (the dashes are enough) +--- + +@import "dash"; diff --git a/dash.gemspec b/dash.gemspec new file mode 100644 index 00000000..61045539 --- /dev/null +++ b/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 diff --git a/index.md b/index.md new file mode 100644 index 00000000..8c0b4450 --- /dev/null +++ b/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