nist-software-theme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e634829aa6926421352e16e265366c42bd339784f0a84a360147405124a4cd2
+  data.tar.gz: c0f65bf06562ff3462147d3929f93a6dc348ef4ac8fa23c49a7f8614dcde114b
+SHA512:
+  metadata.gz: 3cdffbf583475dbfae59ccca6139ab7b9a43b172756d7198de259327831d2a9755868c8fd0b2faa39bfa4825cdbaa61ccbede3f07374be7ba437260485e5f52f
+  data.tar.gz: d070dca9686cecf9a80d5ac9faa04179139880358b89f31183a838989799dc14c1573b185952748213090b5a49e2b802c927f4c1189467b3580abc956d9134a8

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020, National Institute of Standards and Technology
+
+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,107 @@
+# NIST Software Portal Theme for Jekyll Websites
+
+Author: ODI
+
+## Installation
+
+This gem can be used in two ways: either as a gem-based theme or through GitHub pages remote theme support (details [here](https://github.com/blog/2464-use-any-theme-with-github-pages)).
+
+### Gem-Base Theme
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "nist-software-theme"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: nist-software-theme
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install nist-software-theme
+```
+
+It is unclear if the remote theme is suitable for local development, but it will work on deployed sites.
+
+## Usage
+
+This theme supports multiple page websites.
+Any page which is located at `/`, such as `/about.md`, will be added to the navigation bar at the top.
+Each page should include the following YAML front matter:
+
+```yaml
+---
+layout: default
+title: Title of the Page
+---
+```
+
+Currently, there is only the `default` layout.
+
+### Adding a Blog
+
+In true Jekyll fashion, a blog can be created by adding a `_posts/` directory.
+See the [Jekyll Documentation](https://jekyllrb.com/docs/posts/) for details on formatting blog entries.
+
+The following code is an example of how to create a list of blog entries:
+
+```html
+<ul>
+  {% for post in site.posts %}
+    <li>
+      <a href="{{ post.url }}">{{ post.title }}</a>
+    </li>
+  {% endfor %}
+</ul>
+```
+
+## Development
+
+### With Ruby Gems
+
+Assuming working on OS X, tested on OS X 10.11.2. `gem` (Ruby package manager)
+was preinstalled, so just working from there:
+
+```shell
+# Install the dependencies:
+$ gem install jekyll
+
+# Build and serve the website
+$ jekyll serve --baseurl=''
+
+# Browse to (by default) `localhost:4000` in a web browser
+$ open localhost:4000
+```
+
+For more information, check out the full documentation at: http://jekyllrb.com/
+
+### With Bundler
+
+Using [Bundler](https://bundler.io):
+
+```shell
+# Install the dependencies
+$ bundle Install
+
+# Build and serve the website
+$ bundle exec jekyll serve --baseurl=''
+
+# Browse to (by default) `localhost:4000` in a web browser
+$ open localhost:4000
+```
+
+## Release
+
+This Jekyll theme is released under the MIT License. For more details see the
+LICENSE File.

data/_includes/breadcrumbs.html

@@ -0,0 +1,12 @@
+<div id="breadcrumbs">
+    {% assign crumbs = page.url | remove:'/index.html' | split: '/' %}
+    <a href="/">Home</a>
+    {% for crumb in crumbs offset: 1 %}
+    {% if forloop.last %}
+    / {{ page.title }}
+    {% else %}
+    / <a
+        href="{% assign crumb_limit = forloop.index | plus: 1 %}{% for crumb in crumbs limit: crumb_limit %}{{ crumb | append: '/' | replace:'without-plugin/','without-plugins/' }}{% endfor %}">{{ crumb | replace:'-',' ' | remove:'.html' | capitalize }}</a>
+    {% endif %}
+    {% endfor %}
+</div>

data/_includes/footer.html

@@ -0,0 +1,20 @@
+<div id="footer-slim" class="footer">
+  <div class="container">
+
+  <hr />
+
+  <br />
+
+  <div class="row">
+    <div class="col-md-12 subfooter">
+      <a href="https://www.nist.gov/" target="_blank"><img src="https://www.zamzar.com/download.php?uid=c06b88d543148de31da191a19a71afd8-3b4d5011b26fcccb&targetId=2W6cmbYLK6NkBimBUflzV8YPHTZYfCY6&fileID=nist_logo_sidestack_rev.png" alt="NIST" border="0" /></a>
+      <p> National Institute of Standards and Technology <br /> 100 Bureau Drive; Gaitherburg, MD 20899 </p>
+      <p> Operated by the Office of Data and Informatics, for the <br /> National Institute of Standards and Technology. </p>
+    </div>
+
+    <div class="col-md-12 subfooter">
+      <a href="https://www.nist.gov/disclaimer" target="_blank">Privacy &amp; Legal Notice</a>
+    </div>
+  </div>
+  </div>
+</div>

data/_includes/google_analytics.html

@@ -0,0 +1,8 @@
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+  ga('create', '{{ site.google_analytics.tracking_id }}', 'auto');
+  ga('send', 'pageview');
+</script>

data/_includes/head.html

@@ -0,0 +1,17 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <link rel="shortcut icon" href="/assets/css/onelab/0.1.1/images/favicon.ico">
+
+  <link rel="stylesheet" href="/assets/bootstrap/3.3.5/css/bootstrap.min.css" media="screen">
+  <link rel="stylesheet" href="/assets/font-awesome/4.7.0/css/font-awesome.min.css" media="screen">
+
+  <link rel="stylesheet" href="/assets/onelab/0.1.1/css/onelab.css" media="screen">
+
+  <link rel="stylesheet" href="/assets/css/main.css" media="screen">
+
+  {% include custom_head.html %}
+  {% seo %}
+</head>

data/_includes/header.html

@@ -0,0 +1,30 @@
+<nav id="header-slim" class="navbar navbar-default">
+
+  <div class="container">
+    <div class="navbar-header">
+      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#siteNavbar">
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+
+      <p id="nist-menu-tab" class="pull-left"><a href="https://www.nist.gov"></a></p>
+      <a class="navbar-brand" href="{{ site.baseurl }}/">{{ site.title }}</a>
+    </div>
+
+    <div id="siteNavbar" class="collapse navbar-collapse">
+      <ul class="nav navbar-nav navbar-right navbar-collapse">
+        {% if page.path == "index.md" %} <li class="active"> {% else %} <li> {% endif %}
+          <a href="{{ site.baseurl }}/">Home</a></li>
+        {% for node in site.pages reversed %}
+          {% unless node.path == "index.md" %}
+            {% if node.url == page.url %} <li class="active"> {% else %} <li> {% endif %}
+              <a href="{{ node.url | prepend: site.baseurl }}">{{ node.title }}</a></li>
+          {% endunless %}
+        {% endfor %}
+        <li id="github"><a href="https://github.com/usnistgov"><span class="fa fa-github fa-lg"></span></a></li>
+      </ul>
+    </div>
+
+  </div>
+</nav>

data/_includes/scripts.html

@@ -0,0 +1,10 @@
+<!-- jQuery first, then Bootstrap JS. -->
+<script src="/assets/js/jquery-2.1.4.min.js"></script>
+<script src="/assets/js/bootstrap.min.js"></script>
+
+<script src="/assets/js/anchor.min.js"></script>
+<script>
+    anchors.add()
+</script>
+
+{% include google_analytics.html %}

data/_layouts/default.html

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html lang="en">
+
+{% include head.html %}
+
+<body>
+
+{% include header.html %}
+
+<div class="container">
+  {% include breadcrumbs.html %}
+  {{ content }}
+</div>
+
+{% include footer.html %}
+
+{% include scripts.html %}
+
+</body>
+</html>

data/_layouts/entry.html

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html lang="en">
+
+    {% include head.html %}
+
+    <body>
+
+        {% include header.html %}
+
+        <div class="container">
+            <h1>{{ page.title }}</h1>
+
+            <div class="row">
+                <div class="span8">
+                    {{ content }}
+                </div>
+
+                <div class="span4">
+                    <h3>Software Details</h3>
+                    <table>
+                        <tbody>
+                            <tr>
+                                <td class="label">Author</td>
+                                <td>{{ page.author }}</td>
+                            </tr>
+                            <tr>
+                                <td class="label">Release Number</td>
+                                <td>{{ page.release_number }}</td>
+                            </tr>
+                            <tr>
+                                <td class="label">License</td>
+                                <td>{{ page.license }}</td>
+                            </tr>
+                        </tbody>
+                    </table>
+                </div>
+            </div>
+        </div>
+
+        {% include footer.html %}
+
+    </body>
+</html>

data/_layouts/homepage.html

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en" ng-app="app">
+
+    {% include head.html %}
+
+    <body ng-controller="gitHubDataController">
+
+        {% include header.html %}
+
+        <div>
+            <div class="banner"/>
+        </div>
+
+        <div class="container">
+            {{ content }}
+        </div>
+
+        {% include footer.html %}
+
+        {% include scripts.html %}
+
+    </body>
+</html>

data/_layouts/portal.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html lang="en" ng-app="app">
+
+    {% include head.html %}
+
+    <body ng-controller="gitHubDataController">
+
+        {% include header.html %}
+
+        <div class="container">
+            {{ content }}
+        </div>
+
+        {% include footer.html %}
+
+        {% include scripts.html %}
+
+    </body>
+</html>

data/_layouts/post.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html lang="en">
+
+{% include head.html %}
+
+<body>
+
+{% include header.html %}
+
+<div class="container">
+  <div class="row">
+    <h2>
+      <a href="{{ page.url }}">{{ page.title }}</a>
+      <small class="pull-right">{{ page.date | date: '%B %d, %Y' }}</small>
+    </h2>
+
+    {{ content }}
+  </div>
+</div>
+
+{% include footer.html %}
+
+{% include scripts.html %}
+
+</body>
+</html>

data/_layouts/repo.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html lang="en" ng-app="app">
+
+    {% include head.html %}
+
+    <body ng-controller="repoDataController">
+
+        {% include header.html %}
+
+        <div class="container">
+            {{ content }}
+        </div>
+
+        {% include footer.html %}
+
+        {% include scripts.html %}
+
+    </body>
+</html>

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: nist-software-theme
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ODI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+description: 
+email:
+- gretchen.greene@nist.gov
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- _includes/breadcrumbs.html
+- _includes/custom_head.html
+- _includes/footer.html
+- _includes/google_analytics.html
+- _includes/head.html
+- _includes/header.html
+- _includes/scripts.html
+- _layouts/default.html
+- _layouts/entry.html
+- _layouts/homepage.html
+- _layouts/portal.html
+- _layouts/post.html
+- _layouts/repo.html
+homepage: https://github.com/usnistgov/software/nist-software-theme
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: NIST Software Portal Template and Gem
+test_files: []