jekyll-theme-amethyst 0.2.0

data/docs/getting-started.md

@@ -0,0 +1,77 @@
+# Getting started with Amethyst
+
+For a minimal and clean starting point, copy the [example](https://github.com/qunitjs/jekyll-theme-amethyst/tree/example) branch.
+
+For the end-result, see [Amethyst Demo](https://qunitjs.github.io/jekyll-theme-amethyst/), or the [QUnit website](https://qunitjs.com/).
+
+## Create a repository
+
+1. If you haven't already, create a new repository.
+   ```
+   $ mkdir my-site
+   $ cd my-site/
+   my-site$ git init
+   ```
+
+2. Copy the Example files, like so:
+   ```
+   my-site$ git fetch https://github.com/qunitjs/jekyll-theme-amethyst.git example && git checkout FETCH_HEAD .
+   ```
+
+That's it!
+
+You can now run `bundle install && bundle exec jekyll serve` and view the site locally at <http://localhost:4000/>.
+See [README.md](../README.md#contributing) for more details.
+
+## Make it yours
+
+### Configuration
+
+Edit the [_config.yml](https://github.com/qunitjs/jekyll-theme-amethyst/blob/example/_config.yml) file:
+
+* Set `title` to the title of your website.
+* Set `url` to the address of your website.
+  For a sub-project without an own a domain name (e.g. GitHub Pages for a non-org site), also set `baseurl: /my-repo`.
+
+Read more about [Amethyst theme configuration](./config.md#readme).
+
+### Colors
+
+Change the theme colors in [_sass/amethyst-variables.scss](https://github.com/qunitjs/jekyll-theme-amethyst/blob/example/_sass/amethyst-variables.scss#L1).
+
+### Site navigation
+
+Change the top navigation links, or create sub menus, via [sitenav.yml](https://github.com/qunitjs/jekyll-theme-amethyst/blob/example/_data/sitenav.yml).
+
+### Custom domain
+
+See [Manage a custom domain with GitHub Pages](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site).
+
+### Enable Algolia search
+
+1. Create or browse your application in [Algolia](https://www.algolia.com/). (There is a shared "team" for OpenJS Foundation projects. Ask [OpenJS Operations](https://openjsf.org/about/contact/) for your application to be added to the account.)
+2. Go to "API Keys", and take note of the "Search-Only API Key" and "Admin API Key".
+3. Set the following in your `_config.yml` file:
+   - `algolia.application_id`: Application ID.
+   - `amethyst.algolia.search_only_api_key`: Search-Only API Key.
+   - `algolia.index_name`: Unique lowercase name for the current site (e.g. example-com or example-com-foo).
+     This index will be automatically created by GitHub Actions after the next commit.
+4. Create a repository secret on GitHub, named `ALGOLIA_API_KEY`, with the "Admin API Key".
+
+   This is used by the [doc-search](https://github.com/qunitjs/jekyll-theme-amethyst/blob/main/.github/workflows/doc-search.yaml) workflow, which updates the search index after each commit.
+
+Done! The presence of these settings will automatically enable display of the search field.
+
+Terminology:
+
+* **application**:
+  A group of one or more search indexes with an associated "team" of users that can administer those indexes. The application is generally named after a top-level project (e.g. "QUnit") with one or more indexes for its sites (e.g. qunitjs-com and qunitjs-com-api).
+
+  Applications need to be created from the Algolia control panel. The Application IDs are considered public information, and look like `ABCDEF0124`.
+
+* **index**:
+  An index holds the crawled content. These do not need to be created ahead of time. The CI builds will create these as-needed.
+
+  As example, qunitjs.com content may be un a `qunit-com` index, and api.qunitjs.com content under `api-qunitjs-com`. Whenever a site is deployed, the index is replaced with the new content. This is why different subdomains or subprojects that have their own repository should have their own index as otherwise content of the "other" sites would be lost.
+
+  Search suggestions may come from multiple indexes at once. See [Amethyst config](./config.md#readme) for how.

data/favicon.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
+<text y=".9em" font-size="90" fill="#fff">🔮</text>
+</svg>

data/guides.md

@@ -0,0 +1,11 @@
+---
+layout: page
+title: Guides
+---
+
+<p class="lead">The following guides are here to help you.</p>
+
+## [Getting Started](./intro.md)
+
+A guided introduction. If you've never before, or need a refresher on the basics, this is for you.
+

data/index.md

@@ -0,0 +1,51 @@
+---
+layout: home
+
+# Defaults to: site.title
+home_title:
+# Defaults to: site.description
+home_description:
+# Optional
+home_img:
+# Optional
+home_primary_btn:
+  name: Get Started
+  href: /intro/
+# Optional
+home_secondary_btn:
+  name: View the Docs
+  href: /api/
+---
+
+<section class="grid grid--small home-highlights">
+  <div>
+    <h2>Hue</h2>
+    <p>Cupcake ipsum dolor sit amet jujubes marzipan liquorice.</p>
+  </div>
+
+  <div>
+    <h2>Mineral</h2>
+    <p>Gummi bears dessert icing carrot cake. Jelly I love wafer I love powder croissant I love.</p>
+  </div>
+
+  <div>
+    <h2>Quartz</h2>
+    <p>Lemon drops powder oat cake tiramisu powder. I love biscuit I love donut.</p>
+  </div>
+</section>
+
+---
+
+## Join the Community
+
+<p class="lead lead--center" markdown="1">Join us on [Mastodon](https://mastodon.technology/@qunitjs), [Twitter](https://twitter.com/qunitjs), or [Gitter chat](https://gitter.im/qunitjs/qunit).</p>
+
+To contribute:
+
+* [Watch the repository](https://github.com/qunitjs/qunit) to learn about release, new requests, or bug reports.
+* The source of this website, is in the [qunitjs.com](https://github.com/qunitjs/qunitjs.com) repository.
+* The source of the Documentation site, is in the ["docs/" directory](https://github.com/qunitjs/qunit/tree/master/docs).
+
+---
+
+<p class="cta">What are you waiting for? <a href="{{ '/intro/' | relative_url }}" class="button">Get started!</a></p>

data/intro.md

@@ -0,0 +1,41 @@
+---
+layout: page
+title: Getting Started
+---
+
+<p class="lead" markdown="1">The following guide will get you up-and-running in just a few minutes.</p>
+
+## Command
+
+<p class="note" markdown="1">Heads up!</p>
+
+We follow the [Node.js Release schedule](https://github.com/nodejs/LTS), and provide support for Current, Active LTS, and Maintenance LTS releases.
+
+```bash
+npm install --save-dev qunit
+```
+
+## Code snippet
+
+<p class="note note--warning" markdown="1">For legacy reasons, you may have to read this sentence.</p>
+
+Create a `test/add.js` file and call [`QUnit.test()`](https://api.qunitjs.com/QUnit/test/), like so:
+
+```js
+QUnit.module('add', function() {
+  QUnit.test('should add two numbers', function(assert) {
+    assert.equal(add(1, 1), 2, '1 + 1 = 2');
+  });
+});
+```
+
+Check out the [API documentation](https://api.qunitjs.com) or run `qunit --help` to discover more of QUnit's features.
+
+---
+
+## Table
+
+| Sequence | 1 | 2 | 3 | 4
+|--|--
+| Foobar | Foo | Bar | Baz | Quux
+| Lorem ipsum | Lorem | Ipsum | Dolor | Sit

data/lib/jekyll-theme-amethyst.rb

@@ -0,0 +1,39 @@
+# The "file_version_query" Liquid filter appends a query parameter with a file hash.
+#
+# Example: Basic
+#
+#     ```
+#     <img src="{{ "/assets/foo.png" | file_version_query | relative_url }}">
+#     ```
+#     ```
+#     <img src="/assets/foo.png?v=01234567">
+#     ```
+#
+# Example: Link to a generated file that may not yet exist, and hash its input files instead.
+#
+#     ```
+#     <link href="{{ "/assets/style.css" | file_version_query: "/_sass/x.scss", "/_sass/y.scss" }}">
+#     <link href="/assets/style.css?v=01234567">
+#     ```
+#
+require "digest"
+
+module Jekyll
+	module AmethystFilters
+		def file_version_query(input, *filenames)
+			filenames = [input] unless filenames.length > 0
+			hexes = filenames.map do |filename|
+				begin
+					digest = Digest::MD5.file File.join(@context.registers[:site].source, filename)
+				rescue StandardError => e
+					digest = Digest::MD5.file File.join(__dir__, "..", filename)
+				end
+				digest.hexdigest
+			end
+			hex = hexes.length > 1 ? Digest::MD5.hexdigest(hexes.join(" ")) : hexes[0]
+			"#{input}?v=#{hex[0..7]}"
+		end
+	end
+end
+
+Liquid::Template.register_filter(Jekyll::AmethystFilters)

data/tag/event.md

@@ -0,0 +1,5 @@
+---
+layout: posts-tag
+tag: event
+title: Events
+---

data/tag/release.md

@@ -0,0 +1,5 @@
+---
+layout: posts-tag
+tag: release
+title: Release
+---

metadata

@@ -0,0 +1,222 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-theme-amethyst
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Timo Tijhof
+- Trent Willis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: kramdown-parser-gfm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: jekyll-redirect-from
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: jekyll-relative-links
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: jekyll-feed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+- !ruby/object:Gem::Dependency
+  name: jekyll-archives
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/doc-search.yaml"
+- ".github/workflows/gem.yaml"
+- ".github/workflows/github-pages.yaml"
+- ".github/workflows/spider-check.yaml"
+- ".gitignore"
+- 404.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- _config.yml
+- _data/sidebar_api.yml
+- _data/sidebar_blog.yml
+- _data/sitenav.yml
+- _includes/opengraph.html
+- _includes/search-js.html
+- _includes/search.html
+- _includes/sidebar.html
+- _includes/version.html
+- _layouts/group.html
+- _layouts/home.html
+- _layouts/page-api.html
+- _layouts/page.html
+- _layouts/post.html
+- _layouts/posts-archive.html
+- _layouts/posts-author.html
+- _layouts/posts-tag.html
+- _layouts/posts-year.html
+- _layouts/posts.html
+- _layouts/wrapper.html
+- _posts/2006-01-26-announcing-the-blog.md
+- _posts/2006-10-18-foo-110.md
+- _posts/2007-10-18-foo-112.md
+- _posts/2008-10-18-foo-126.md
+- _posts/2009-10-18-foo-132.md
+- _posts/2010-10-18-foo-143.md
+- _posts/2011-10-18-foo-171.md
+- _posts/2012-10-18-foo-183.md
+- _posts/2013-10-18-foo-191.md
+- _posts/2014-10-18-foo-211.md
+- _posts/2015-10-18-foo-300.md
+- _posts/2017-10-18-foo-321.md
+- _posts/2018-10-18-foo-331.md
+- _posts/2019-10-18-foo-341.md
+- _posts/2020-04-01-foo-350.md
+- _posts/2020-10-18-foo-351.md
+- _posts/2021-04-01-hello-world.md
+- _sass/amethyst-variables.scss
+- _sass/amethyst.scss
+- _sass/custom.scss
+- _sass/highlight.scss
+- about.md
+- amethyst.gemspec
+- api/deprecated.md
+- api/foo/baz.md
+- api/foo/index.md
+- api/foo/quux.md
+- api/index.md
+- api/lorem/dolor.md
+- api/lorem/index.md
+- api/lorem/sit.md
+- api/removed.md
+- assets/logo-algolia.svg
+- assets/styles.scss
+- blog-archive.md
+- blog.md
+- docs/config.md
+- docs/getting-started.md
+- favicon.svg
+- guides.md
+- index.md
+- intro.md
+- lib/jekyll-theme-amethyst.rb
+- tag/event.md
+- tag/release.md
+homepage: https://github.com/qunitjs/jekyll-theme-amethyst
+licenses:
+- MIT
+metadata:
+  plugin_type: theme
+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.1.2
+signing_key: 
+specification_version: 4
+summary: https://github.com/qunitjs/jekyll-theme-amethyst
+test_files: []