jekyll-theme-rocket 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6cbe90a5b5f035a731762eeb597a5eb61e89bb3b6fc229a17051921fcd73167
-  data.tar.gz: dc1600c0544df604341bfa77436a1bf9d0aaa2a637469af3d83079c6957474af
+  metadata.gz: 3ee4baa519535235401f96a9bf75e4f349f1938af414d4928581d021dbcd37f8
+  data.tar.gz: 9355b61b3cee307bd5edd6c3156b9da5840442658318c28a4fc5c1e9208b03cc
 SHA512:
-  metadata.gz: 659f0c01229105630d562687b2c58184272d8e1d333655f6163ecb5afa88f7ce014adcb6e2c339d7902878870e4dad52e19218b106306bf0d0a6e0a600beb1e1
-  data.tar.gz: 167b0d5dd6796e776731e7ea3a260750289529403828c91a613f521769d995439419e1dc0eba2254e2a5dacd17f2c52f11b0b7ba7efbe93082faa59232ee6f2c
+  metadata.gz: 81c5d4b52dfc19d7c628b0bbd491b4d87ea59b9749cdaec7a5458768466cd8260c54d06b790ed4c1156f704aaa0127ca59f6c7a952f444e092e46b6eac78c4cd
+  data.tar.gz: e35c40589c47ac0b9fdd9e910e2c1a1c9f9ae34a771d494aa98cc9e69aba6b85a0507c4435455889fb40441e3669865feb6841c10ab576e0f3f470d557f703fc

data/LICENSE

@@ -0,0 +1,116 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific
+works ("Commons") that the public can reliably and without fear of later
+claims of infringement build upon, modify, incorporate in other works, reuse
+and redistribute as freely as possible in any form whatsoever and for any
+purposes, including without limitation commercial purposes. These owners may
+contribute to the Commons to promote the ideal of a free culture and the
+further production of creative, cultural and scientific works, or to gain
+reputation or greater distribution for their Work in part through the use and
+efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation
+of additional consideration or compensation, the person associating CC0 with a
+Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
+and publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not limited
+to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display, communicate,
+  and translate a Work;
+
+  ii. moral rights retained by the original author(s) and/or performer(s);
+
+  iii. publicity and privacy rights pertaining to a person's image or likeness
+  depicted in a Work;
+
+  iv. rights protecting against unfair competition in regards to a Work,
+  subject to the limitations in paragraph 4(a), below;
+
+  v. rights protecting the extraction, dissemination, use and reuse of data in
+  a Work;
+
+  vi. database rights (such as those arising under Directive 96/9/EC of the
+  European Parliament and of the Council of 11 March 1996 on the legal
+  protection of databases, and under any national implementation thereof,
+  including any amended or successor version of such directive); and
+
+  vii. other similar, equivalent or corresponding rights throughout the world
+  based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
+and Related Rights and associated claims and causes of action, whether now
+known or unknown (including existing as well as future claims and causes of
+action), in the Work (i) in all territories worldwide, (ii) for the maximum
+duration provided by applicable law or treaty (including future time
+extensions), (iii) in any current or future medium and for any number of
+copies, and (iv) for any purpose whatsoever, including without limitation
+commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
+the Waiver for the benefit of each member of the public at large and to the
+detriment of Affirmer's heirs and successors, fully intending that such Waiver
+shall not be subject to revocation, rescission, cancellation, termination, or
+any other legal or equitable action to disrupt the quiet enjoyment of the Work
+by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver
+shall be preserved to the maximum extent permitted taking into account
+Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
+is so judged Affirmer hereby grants to each affected person a royalty-free,
+non transferable, non sublicensable, non exclusive, irrevocable and
+unconditional license to exercise Affirmer's Copyright and Related Rights in
+the Work (i) in all territories worldwide, (ii) for the maximum duration
+provided by applicable law or treaty (including future time extensions), (iii)
+in any current or future medium and for any number of copies, and (iv) for any
+purpose whatsoever, including without limitation commercial, advertising or
+promotional purposes (the "License"). The License shall be deemed effective as
+of the date CC0 was applied by Affirmer to the Work. Should any part of the
+License for any reason be judged legally invalid or ineffective under
+applicable law, such partial invalidity or ineffectiveness shall not
+invalidate the remainder of the License, and in such case Affirmer hereby
+affirms that he or she will not (i) exercise any of his or her remaining
+Copyright and Related Rights in the Work or (ii) assert any associated claims
+and causes of action with respect to the Work, in either case contrary to
+Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+  a. No trademark or patent rights held by Affirmer are waived, abandoned,
+  surrendered, licensed or otherwise affected by this document.
+
+  b. Affirmer offers the Work as-is and makes no representations or warranties
+  of any kind concerning the Work, express, implied, statutory or otherwise,
+  including without limitation warranties of title, merchantability, fitness
+  for a particular purpose, non infringement, or the absence of latent or
+  other defects, accuracy, or the present or absence of errors, whether or not
+  discoverable, all to the greatest extent permissible under applicable law.
+
+  c. Affirmer disclaims responsibility for clearing rights of other persons
+  that may apply to the Work or any use thereof, including without limitation
+  any person's Copyright and Related Rights in the Work. Further, Affirmer
+  disclaims responsibility for obtaining any necessary consents, permissions
+  or other rights required for any use of the Work.
+
+  d. Affirmer understands and acknowledges that Creative Commons is not a
+  party to this document and has no duty or obligation with respect to this
+  CC0 or use of the Work.
+
+For more information, please see
+<http://creativecommons.org/publicdomain/zero/1.0/>

data/README.md

@@ -0,0 +1,87 @@
+# The Rocket theme
+
+
+*Rocket is a Jekyll theme for GitHub Pages inspired by [rocket.rs](https://rocket.rs) style.*
+
+
+## Usage
+
+To use the Rocket theme:
+
+1. Add the following to your site's `_config.yml`:
+
+    ```yml
+    remote_theme: L-Nafaryus/jekyll-theme-rocket@v0.0.1
+    plugins:
+    - jekyll-remote-theme # add this line to the plugins list if you already have one
+    ```
+
+2. Optionally, if you'd like to preview your site on your computer, add the following to your site's `Gemfile`:
+
+    ```ruby
+    gem "github-pages", group: :jekyll_plugins
+    ```
+
+## Customizing
+
+### Configuration variables
+
+Rocket will respect the following variables, if set in your site's `_config.yml`:
+
+```yml
+title: [The title of your site]
+description: [A short description of your site's purpose]
+```
+
+Additionally, you may choose to set the following optional variables:
+
+```yml
+show_downloads: ["true" or "false" (unquoted) to indicate whether to provide a download URL]
+google_analytics: [Your Google Analytics tracking ID]
+```
+
+### Stylesheet
+
+If you'd like to add your own custom styles:
+
+1. Create a file called `/assets/css/style.scss` in your site
+2. Add the following content to the top of the file, exactly as shown:
+    ```scss
+    ---
+    ---
+
+    @import "{{ site.theme }}";
+    ```
+3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line
+
+*Note: If you'd like to change the theme's Sass variables, you must set new values before the `@import` line in your stylesheet.*
+
+### Layouts
+
+If you'd like to change the theme's HTML layout:
+
+1. For some changes such as a custom `favicon`, you can add custom files in your local `_includes` folder. The files [provided with the theme](https://github.com/L-Nafaryus/jekyll-theme-rocket/tree/master/_includes) provide a starting point and are included by the [original layout template](https://github.com/L-Nafaryus/jekyll-theme-rocket/blob/master/_layouts/default.html).
+2. For more extensive changes, [copy the original template](https://github.com/L-Nafaryus/jekyll-theme-rocket/blob/master/_layouts/default.html) from the theme's repository<br />(*Pro-tip: click "raw" to make copying easier*)
+3. Create a file called `/_layouts/default.html` in your site
+4. Paste the default layout content copied in the first step
+5. Customize the layout as you'd like
+
+### Customizing Google Analytics code
+
+Google has released several iterations to their Google Analytics code over the years since this theme was first created. If you would like to take advantage of the latest code, paste it into `_includes/head-custom-google-analytics.html` in your Jekyll site.
+
+For more information, see [the Jekyll variables documentation](https://jekyllrb.com/docs/variables/).
+
+### Previewing the theme locally
+
+If you'd like to preview the theme locally (for example, in the process of proposing a change):
+
+1. Clone down the theme's repository (`git clone https://github.com/L-Nafaryus/jekyll-theme-rocket`)
+2. `cd` into the theme's directory
+3. Run `gem install bundler && bundle install` to install the necessary dependencies
+4. Run `bundle exec jekyll serve` to start the preview server
+5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the theme
+
+### Running build 
+
+The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the build, simply run `scripts/build.sh`. 

data/_includes/head-custom.html

@@ -0,0 +1,10 @@
+<!-- start custom head snippets, customize with your own _includes/head-custom.html file -->
+
+
+<!-- Setup Google Analytics -->
+{% include head-custom-google-analytics.html %}
+
+<!-- You can set your favicon here -->
+<!-- link rel="shortcut icon" type="image/x-icon" href="{{ '/favicon.ico' | relative_url }}" -->
+
+<!-- end custom head snippets -->

data/_layouts/default.html

@@ -0,0 +1,71 @@
+<!doctype html>
+<html lang="{{ site.lang | default: "en-US" }}">
+    <head>
+        <meta charset="utf-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=edge">
+
+        {% seo %}
+
+        <link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
+        <script src="https://code.jquery.com/jquery-1.12.4.min.js" integrity="sha256-ZosEbRLbNQzLpnKIkEdrPv7lOy9C27hHQ+Xp8a4MxAQ=" crossorigin="anonymous"></script>
+        <script src="{{ '/assets/js/respond.js' | relative_url }}"></script>
+
+        <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
+
+
+        {% include head-custom.html %}
+    </head>
+
+    <body>
+        <header>
+            <div class="container">
+                <a id="logo" href="{{ '/' | relative_url }}">
+                    <!--<img src="{{ '/assets/images/logo.png' | relative_url }}" width="48" height="48">-->
+                </a>
+                
+                <input type="checkbox" id="toggle">
+                <label for="toggle" class="hamburger">
+                    <span></span>
+                    <span></span>
+                    <span></span>
+                </label>
+
+                <nav class="main">
+                    <a href="{{ '/' | relative_url }}">Home</a>
+                    <a href="{{ site.github.repository_url }}">GitHub</a>
+                </nav>
+
+                <div class="centered">
+                    <h1>{{ site.title | default: site.github.repository_name }}</h1>
+                </div>
+            </div>
+        </header>
+
+        <section class="grid tight blocky-code">
+            <div id="sidebar">
+                <nav>
+                    <div class="toc mobile-hide">
+                        <ul>
+                            <!-- navigation -->
+                        </ul>
+                    </div>
+                </nav>
+            </div>
+
+            <article>
+                {{ content }}
+            </article>
+        </section>
+
+        <footer class="grid light">
+            <div class="container">
+                <div class="col">
+                    Project maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a>
+                </div>
+                <!--<div class="col text-right mobile-hide">
+                    <a href="#">Back to top Δ</a>
+                </div>-->
+            </div>
+        </footer>
+    </body>
+</html>