Merge pull request #17 from MichaelCurrin/add-jekyll

Convert to static site by adding Jekyll

Author: MichaelCurrin

.gitignore

@@ -0,0 +1,9 @@
+_site/
+
+.jekyll-metadata
+
+.jekyll-cache/
+.sass-cache/
+
+.bundle/
+vendor/

CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing
+
+If you want to add or update content, fork the project to your own repos, make a feature branch and add a Pull Request to the original repo.
+
+If you'd like to just request an addition or fix, create an issue under [Issues](https://github.com/MichaelCurrin/dev-cheatsheets/issues).

Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'jekyll', '~> 3.8.5'
+gem 'minima', '~> 2.0'
+
+group :jekyll_plugins do
+  gem 'jekyll-feed', '~> 0.6'
+  gem 'jekyll-sitemap', '~> 1.4.0'
+end

Gemfile.lock

@@ -0,0 +1,74 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.6)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
+    ffi (1.13.1)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.6.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (3.8.7)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 4)
+      safe_yaml (~> 1.0)
+    jekyll-feed (0.14.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-seo-tag (2.6.1)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-sitemap (1.4.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (1.17.0)
+    liquid (4.0.3)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.3.6)
+    minima (2.5.1)
+      jekyll (>= 3.5, < 5.0)
+      jekyll-feed (~> 0.9)
+      jekyll-seo-tag (~> 2.1)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (4.0.5)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rouge (3.20.0)
+    safe_yaml (1.0.5)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jekyll (~> 3.8.5)
+  jekyll-feed (~> 0.6)
+  jekyll-sitemap (~> 1.4.0)
+  minima (~> 2.0)
+
+BUNDLED WITH
+   1.17.2

Makefile

@@ -0,0 +1,17 @@
+default: install
+
+help:
+	@egrep '^\S|^$$' Makefile
+
+install:
+	bundle config --local path vendor/bundle
+	bundle install
+
+upgrade:
+	bundle update
+
+s serve:
+	bundle exec jekyll serve --trace --livereload
+
+build-prod:
+	JEKYLL_ENV=production bundle exec jekyll build

README.md

@@ -1,51 +1,24 @@
 # Cheatsheets
-> Collection of minimal code snippets across languages for easy reference
+> A collection of code snippets and CLI notes for easy reference
 
 
-## Purpose
+[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/dev-cheatsheets)](https://github.com/MichaelCurrin/dev-cheatsheets/tags/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue)](#license)
 
-A reference for code snippets and shell commands across programming languages. It contains a way doing things based on previous or expected use-cases which highly relevant for me. It serves as a cache of sorts - I look in my cheatsheets for syntax or approach to a use-case first and then add Google, StackOverflow, documentation, etc. And when I find the answer I add it here so next time my search will be quicker and I'll find the same answer each time.
+[![View site GH Pages](https://img.shields.io/badge/View_site-GH_Pages-green?style=for-the-badge)](https://MichaelCurrin.github.io/dev-cheatsheets/)
 
-This guide is not aimed at teaching fundamentals of a language or explaining things to beginners - it assumes context. It aims to be lean and easy to navigate with a focus on code over explanations for compactness, but sometimes it still explains how or why to use a snippet.
 
-There are plenty of tutorials and cheatsheets out there. This one is unique (for my at least) as it only contains topic and code that I have actually used before or plan to use, so it's a reference of what I know (or once knew). A cheatsheet made by someone is not personal to me and might have things I don't need or in a layout I don't like.
+## Documentation
 
-I do link to other cheatsheets in some cases here, but when I have time I like to bring in a few items to my own guide, since external sites will not always be around as pages or domains.
+See the [docs](/docs/) directory.
 
-<!-- NOTES
+Contributions are welcome - see [Contributing](/CONTRIBUTING.md) doc.
 
-## Ramblings
 
-I add code here if I find I use it more than once, from other cheatsheets, StackOverflow or my own creation. There may be links, but the idea is to be explicit here to avoid clicking through and also the risk of external content moving/disappearing.
+## License
 
-The idea is to have boilerplate and templates which I already I understand and can use as a reference. This is not aimed at learning the language or concept for the first time.
+Released under [MIT](/LICENSE).
 
-The code here might not actually run, especially templates.
+You must include a copy of this original license if you fork this repo or use a significant portion of it.
 
-I am likely going to copy-paste the things in here often. Just to make typing it that much easier and to save a Stack Overflow search for an item I found before.
-
-I might memorize the items, or just type them out enough times that I know them, but I keep as a cheatsheet for long term use.
-
-There are also hacks which are not necessarily useful to someone learning the language but something I use.
-
-There might also be links to cheatsheets I've found. I might take an existing cheatsheet and cut it down to the stuff I don't know so well yet but am likely to need.
-
-The idea is to keep this project as a lean as possible. Wider details on learning or using a language are covered in my other projects.
-
-There may be missing context or explanations and obvious things are excluded. As the cheatsheet is intended for myself mainly.
--->
-
-## Resources
-
-Any links to tutorials and more detail will probably be added to my [Learn to Code](https://github.com/MichaelCurrin/learn-to-code) project instead.
-
-For creating doc badges see [Badge Generator](https://michaelcurrin.github.io/badge-generator).
-
-## Other cheatsheets
-
-- https://devhints.io
-- http://cheatsheetfactory.geekyhacker.com/
-
-<!--stackedit_data:
-eyJoaXN0b3J5IjpbMTY1NDgxMTkzNF19
--->
+Github corner SVG from: http://tholman.com/github-corners/

TODO

@@ -1,3 +1,39 @@
+Dev notes to self
+
+Convert all links to Jekyll style
+
+Add hover for flex - currently doesn't work nice on div and darkness is too big
+
+Set background color of header
+and of flex boxes to cornflowerblue and white text
+Use SCSS instead maybe change background color var
+
+Reuse flex sections aside from homepage
+
+Keep CSS separate and with the HTML. Reuse items like edit or SVG in recipes.
+
+Consider cheatsheets folder to be cs or sheets
+
+Unsorted / uncategorized?
+
+Homepage vs cheatsheets page? About page? Welcome home?
+Should homepage just be a splash / cover and CTA to get to cheatsheets?
+Preview? Latest updated? Not possible
+
+Or get rid of layer and move folders to root. All the .md files will be moved to subfolder so that will be clean.
+
+
+Add search
+
+
+Replace _ with -
+
+Add Edit this page
+
+Add sidebar
+
+===
+
 should some of these just be moved to cheatsheets folder in Learn to Code?
 Are these aimed at me and that at others?
 

_config.yml

@@ -0,0 +1,41 @@
+### Site metadata ###
+
+title: Dev Cheatsheets
+description: A collection of code snippets and CLI notes for easy reference
+
+github_username: MichaelCurrin
+
+### Build settings ###
+
+url: "https://michaelcurrin.github.io"
+baseurl: "/dev-cheatsheets"
+
+theme: minima
+
+header_pages:
+  - index.md
+  - cheatsheets/index.md
+  - about.md
+
+plugins:
+  - jekyll-feed
+  - jekyll-sitemap
+
+exclude:
+  - docs/
+  - vendor/
+  - CONTRIBUTING.md
+  - Gemfile
+  - Gemfile.lock
+  - LICENSE
+  - Makefile
+  - README.md
+
+# Warning - there are memory issues when using a pattern to define listing
+# layout for `cheatsheets/**/index.md` or even `cheatsheets/*/index.md`,
+# therefore it is best to be explicit in each index file.
+defaults:
+  - scope:
+      path: ""
+    values:
+      layout: "page"

_includes/breadcrumbs.html

@@ -0,0 +1,19 @@
+<div id="breadcrumbs">
+{% assign crumbs = page.url | remove: '/index.html' | split: '/' %}
+
+    {% if crumbs.size > 2 %}
+        {% for crumb in crumbs offset: 1 %}
+            {% unless forloop.first %}
+            /
+            {% endunless %}
+            {% if forloop.last %}
+                {{ page.title }}
+            {% else %}
+                {% assign crumb_limit = forloop.index | plus: 1 %}
+                <a href="{{ site.baseurl }}{% for crumb in crumbs limit: crumb_limit %}{{ crumb | append: '/' }}{% endfor %}">
+                    {{- crumb | replace: '-', ' ' | remove: '.html' | capitalize -}}
+                </a>
+            {% endif %}
+        {% endfor %}
+    {% endif %}
+</div>

_includes/edit-on-github.html

@@ -0,0 +1,9 @@
+<a id="edit-me" href="https://github.com/{{ site.github_username }}{{ site.baseurl }}/edit/master/{{ page.path }}">
+    📝<span>Edit on GitHub</span>
+</a>
+<style>
+    #edit-me {
+        float:right;
+    }
+
+</style>