namecard 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6bd612c8c5ea02ebe4f7c21a59e8a966b74927e0cbdc73e2bddec54c1319d886
+  data.tar.gz: 44f01a0d107d453e48ed5e2f1418dd750187775ab50c3c1633e846106bf71929
+SHA512:
+  metadata.gz: 9b3e9ff1ac9761ef3947cf0ee73086bd5cc6f3a474a3ae24ca0e43ba6762f896afe8c42bc60d51ab93678829a349cd5de2101d867fcbd714f263371e7bf18e29
+  data.tar.gz: 732854e9f5b75ddf283f668a30dcde13b2b2bc499d7e5b926a4ad1f81a3509343a37aaac9cb3a8155f0980aadbcd5d09e5d4fbfa52bd5e467e204ac41a3711f2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 afterdusk
+
+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.

data/README.md

@@ -0,0 +1,72 @@
+# namecard
+
+![namecard](/assets/namecard.png)
+
+### *namecard* is a markdown-driven, single page CV
+
+**markdown-driven**: all of the content and most of the styling on the site can be edited with markdown - this grants flexibility without compromising ease of use
+
+**single page**: a single page is concise and doesn't overwhelm visitors - see the [*KISS*](https://en.wikipedia.org/wiki/KISS_principle) principle. (This also means that at this time, there's no support for posts)
+
+## Usage
+
+Usage instructions and theme options are available at https://github.com/afterdusk/use-namecard, an example site using *namecard*. I highly recommend cloning the repository and editing the content from the template instead of performing an install on an existing repo.
+
+## Installation
+There are two ways of installing Jekyll themes:
+
+### 1. Gem Installation
+---
+Note that this approach will not work with GitHub Pages build and deploy. If you are using this approach and want to deploy with GitHub Pages, you will have to build your site locally and only push the output `_site` folder.
+
+---
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "namecard"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: namecard
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself with:
+
+    $ gem install namecard
+
+### 2. GitHub Pages Remote Theme
+If you plan to deploy with GitHub Pages, this is the far simpler approach of adding the theme to your site. Add the following line to your site's `_config.yml`:
+
+```yaml
+remote_theme: afterdusk/namecard
+```
+
+In your `Gemfile`, ensure the following lines are commented out:
+```ruby
+# gem "namecard"
+# gem "jekyll", "~> 3.8.5"
+```
+
+And uncomment the line:
+```ruby
+gem "github-pages", "~> 204", group: :jekyll_plugins
+```
+
+Note: Make sure a version number is included in the above line
+
+You can then [test the site locally](https://help.github.com/en/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll) before [deploying to GitHub pages](https://help.github.com/en/github/working-with-github-pages/creating-a-github-pages-site-with-jekyll).
+
+## Contributing
+
+Bug reports, suggestions and pull requests are welcome on GitHub at https://github.com/afterdusk/namecard. 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.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_includes/analytics.html

@@ -0,0 +1,9 @@
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google_analytics }}"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+  function gtag(){dataLayer.push(arguments);}
+  gtag('js', new Date());
+
+  gtag('config', '{{ site.google_analytics }}');
+</script>

data/_includes/dark_mode.html

@@ -0,0 +1,16 @@
+<script>
+  const darkModeQuery = '(prefers-color-scheme: dark)';
+  const darkModeClass = 'dark-mode'
+
+  if (window.matchMedia && window.matchMedia(darkModeQuery).matches) {
+    document.body.classList.add(darkModeClass);
+  }
+
+  window.matchMedia(darkModeQuery).addEventListener('change', e => {
+    toggleDarkMode();
+  });
+
+  function toggleDarkMode() {
+    document.body.classList.toggle(darkModeClass);
+  }
+</script>

data/_includes/footer.html

@@ -0,0 +1,3 @@
+<footer class="footer" aria-label="Footer">
+  &copy; namecard
+</footer>

data/_includes/head.html

@@ -0,0 +1,12 @@
+<head>
+  <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    {%- seo -%}
+    <link rel="stylesheet" href="{{ '/assets/style.css' | relative_url }}">
+
+    <!-- google analytics -->
+    {%- if jekyll.environment == 'production' and site.google_analytics -%}
+      {%- include analytics.html -%}
+    {%- endif -%}
+
+</head>

data/_layouts/404.html

@@ -0,0 +1,26 @@
+---
+---
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: 'en' }}">
+
+  {%- include head.html -%}
+
+  <body>
+
+    <main class="container-fluid">
+      <div class="row">
+        <div class="intro col-sm-8">
+          {{ page.content | markdownify }}
+        </div>
+      </div>
+    </main>
+
+    <!-- footer -->
+    {%- include footer.html -%}
+
+  </body>
+
+  <!-- dark mode -->
+  {%- include dark_mode.html -%}
+
+</html>

data/_layouts/main.html

@@ -0,0 +1,90 @@
+---
+---
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: 'en' }}">
+
+  {%- include head.html -%}
+
+  <body>
+
+    <!-- necessary as specifying collection order in _config.yml is not possible in Jekyll 3 -->
+    {% assign sorted_sections = site.sections | sort: 'order' %}
+
+    <!-- navbar -->
+    <nav class="nav-bar" aria-label="Navigation Bar">
+      {% for section in sorted_sections %}
+        {% if section.anchor %}
+          <a class="nav-item" href="{{ section.anchor  | prepend: '#' | relative_url }}">
+            {{ section.title | markdownify | strip_html }}
+          </a>
+        {% endif %}
+      {% endfor %}
+    </nav>
+
+    <main class="container-fluid">
+      <!-- intro -->
+      <div class="row">
+        <div class="intro col-sm-8" aria-label="Intro">
+          <div class="intro-title">{{ site.intro_title | markdownify }}</div>
+          <div class="intro-content">{{ site.intro_content | markdownify }}</div>
+          {%- if site.github_url -%}
+            <a href="{{ site.github_url }}" class="fa fa-github" title="GitHub profile"></a>
+          {%- endif -%}
+          {%- if site.stack_overflow_url -%}
+            <a href="{{ site.stack_overflow_url }}" class="fa fa-stack-overflow" title="Stack Overflow profile"></a>
+          {%- endif -%}
+          {%- if site.linkedin_url -%}
+            <a href="{{ site.linkedin_url }}" class="fa fa-linkedin" title="LinkedIn profile"></a>
+          {%- endif -%}
+          {%- if site.facebook_url -%}
+            <a href="{{ site.facebook_url }}" class="fa fa-facebook" title="Facebook profile"></a>
+          {%- endif -%}
+          {%- if site.twitter_url -%}
+            <a href="{{ site.twitter_url }}" class="fa fa-twitter" title="Twitter profile"></a>
+          {%- endif -%}
+          {%- if site.youtube_url -%}
+            <a href="{{ site.youtube_url }}" class="fa fa-youtube" title="YouTube profile"></a>
+          {%- endif -%}
+          {%- if site.email -%}
+            <a href="mailto:{{ site.email }}" class="fa fa-envelope" title="Email"></a>
+          {%- endif -%}
+        </div>
+      </div>
+
+      <!-- sections -->
+      {% for section in sorted_sections %}
+      <div class="section row" aria-label="Sections">
+        <div id="{{ section.anchor }}" class="section-title col-sm-5">{{ section.title | markdownify }}</div>
+        <div class="section-content col-sm-7">{{ section.content | markdownify }}</div>
+      </div>
+      {% endfor %}
+    </main>
+
+    <!-- footer -->
+    {%- include footer.html -%}
+
+  </body>
+
+  <!-- dark mode -->
+  {%- include dark_mode.html -%}
+</html>
+
+    <!-- // <button onclick="toggleDarkMode()"> </button>
+    // // auto-id generation
+    // // see: https://kramdown.gettalong.org/converter/html.html
+    // function getSectionId(name) {
+    //   // remove all characters except letters, numbers, spaces and dashes
+    //   var res = name.replace(/[^a-zA-Z0-9 -]/g,'');
+    //   // remove all characters from the start of the line until the first letter
+    //   res = /[a-zA-Z](.+)/.exec(res)[0];
+    //   // convert everything except letters and numbers to dashes
+    //   res = res.replace(/[^a-zA-Z0-9]/g, "-");
+    //   // lowercase
+    //   res = res.toLowerCase();
+    //   // if nothing is left, use "section"
+    //   if (res.length === 0) {
+    //     res = "section";
+    //   }
+    //   // name-collision omitted, all section headers assumed to be unique
+    //   return res;
+    // } -->

data/assets/style.scss

@@ -0,0 +1,217 @@
+---
+---
+// bootstrap
+@import url(https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css);
+// google fonts
+@import url('https://fonts.googleapis.com/css2?family=Raleway:wght@400;600&display=swap');
+@import url('https://fonts.googleapis.com/css2?family=Roboto&display=swap');
+// social media buttons
+@import url('https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css');
+
+$xs-breakpoint: 480px;
+$sm-breakpoint: 768px;
+
+/***** FONTS *****/
+$font-size-base: 1.6rem;
+$font-size-jumbo: 4.2rem;
+$icon-size: 4.2rem;
+$icon-width: 4.2rem;
+
+$font-family: 'Raleway', sans-serif;
+$font-family-secondary: 'Roboto', sans-serif;
+
+/***** COLORS *****/
+$background-color: #ffffff;
+$background-color-dark: #0e171c;
+$text-color: #000000;
+$text-color-dark: #ffffff;
+$text-accent-color: {{ site.accent_color | default: "#0070c0" }};
+$text-accent-color-dark: {{ site.accent_color_dark | default: "#039cfd" }};
+
+/***** MARKDOWN INJECTABLE CLASSES *****/
+.accent-color { // usage: {: .accent-color}
+  color: $text-accent-color;
+
+  a {
+    color:inherit
+  }
+}
+
+.jumbo-font { // usage: {: .jumbo-font}
+  font-size: $font-size-jumbo;
+}
+
+.secondary-font { // usage: {: .secondary-font}
+  font-family: $font-family-secondary;
+}
+
+/***** MARKDOWN STYLE OVERRIDES *****/
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+  margin-top: 0.2em;
+  margin-bottom: 0.2em;
+  line-height: 1.2em;
+}
+
+p {
+  font-size: $font-size-base;
+  margin-top: 0.2em;
+  margin-bottom: 0.2em;
+}
+
+ul,
+ol {
+  margin-top: 0.2em;
+  margin-bottom: 0.2em;
+  padding: 0;
+}
+
+li {
+  font-size: $font-size-base;
+  margin-bottom: 0.2em;
+}
+
+a:hover {
+  text-decoration: none;
+  opacity: 0.85;
+}
+
+img {
+  margin-top: 0.4em;
+  margin-bottom: 0.4em;
+  width: 32rem;
+  max-width: 100%;
+  max-height: 100%;
+}
+
+table {
+  table-layout: fixed;
+  width: 100%;
+}
+
+td,
+th {
+  font-size: $font-size-base;
+  margin-top: 0.2em;
+  margin-bottom: 0.2em;
+  padding: 0.4em 0;
+}
+
+/***** PAGE STYLING *****/
+html {
+  height: 100%;
+  scroll-behavior: smooth;
+}
+
+body {
+  display: flex;
+  flex-direction: column;
+  max-width: 100rem;
+  min-height: 100%;
+  margin: auto;
+  padding: 7rem 10rem; // top-bottom left-right
+
+  background-color: $background-color;
+  color: $text-color;
+  font-family: $font-family;
+  font-size: $font-size-base;
+}
+
+nav {
+  text-align: right;
+
+  .nav-item {
+    color: inherit;
+    font-weight: bold;
+    margin: 0.4rem;
+  }
+
+  .nav-item:hover {
+    color: $text-accent-color;
+    text-decoration: none;
+  }
+}
+
+main {
+  flex-grow: 1;
+
+  .intro {
+    padding: 10em 1rem;
+  }
+
+  .section {
+    padding-bottom: 4rem;
+
+    .section-title {
+      padding: 1rem;
+    }
+
+    .section-content {
+      padding: 1rem;
+      padding-bottom: 2rem;
+    }
+  }
+}
+
+footer {
+  align-self: end;
+  width: 100%;
+  text-align: right;
+}
+
+.fa {
+  color: inherit;
+  margin: 0.6em;
+  margin-left: 0;
+  font-size: $icon-size;
+  width: $icon-width;
+  text-align: center;
+  text-decoration: none;
+}
+
+.fa:hover {
+  color: $text-accent-color;
+  text-decoration: none;
+}
+
+/***** DARK MODE *****/
+.dark-mode {
+  background-color: $background-color-dark;
+  color: $text-color-dark;
+
+  .accent-color {
+    color: $text-accent-color-dark;
+  }
+
+  .fa:hover {
+    color: $text-accent-color-dark;
+  }
+
+  .nav-item:hover {
+    color: $text-accent-color-dark;
+  }
+}
+
+/***** PAGE STYLING (MOBILE) *****/
+@media only screen and (max-width : $xs-breakpoint) {
+  body {
+    padding: 7rem 2rem;
+  }
+
+  .nav-bar {
+    .nav-item {
+      display: block;
+      margin: 1em 0em;
+    }
+  }
+}
+
+@media (hover:none), (hover:on-demand) {
+  a:hover {
+    color: inherit; // to avoid sticky hover
+  }
+}

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: namecard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- afterdusk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.5
+- !ruby/object:Gem::Dependency
+  name: jekyll-seo-tag
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: 
+email:
+- hello@evanau.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- _includes/analytics.html
+- _includes/dark_mode.html
+- _includes/footer.html
+- _includes/head.html
+- _layouts/404.html
+- _layouts/main.html
+- assets/namecard.png
+- assets/style.scss
+homepage: https://www.github.com/afterdusk/namecard
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Markdown driven, single page CV
+test_files: []