Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 2.48 KB

getting-started.md

File metadata and controls

61 lines (39 loc) · 2.48 KB
Raw

Getting started with Amethyst

For a minimal and clean starting point, copy the example branch.

For the end-result, see Amethyst Demo, or the QUnit website.

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 for more details.

Make it yours

Configuration

Edit the _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.

Colors

Change the theme colors in _sass/amethyst-variables.scss.

Site navigation

Change the top navigation links, or create sub menus, via sitenav.yml.

Custom domain

See Manage a custom domain with GitHub Pages.

Enable Typesense

Optional autocompletion with search suggestions.

  1. Follow Create scraper. Feel free to ask the jQuery Infrastructure Team for help.
  2. Set the following in your _config.yml file:
    • amethyst.typesense.origin: https://typesense.jquery.com
    • amethyst.typesense.collection: Unique lowercase name for the current site (e.g. example_com or example_foo). This should match the index name used by your scraper.
    • amethyst.typesense.search_only_api_key: Search-only key (copy from another repo, or consult the jQuery Infrastucture credentials vault.)

Done! The presence of these settings will automatically enable autocompletion on the search field.