About the Dove project

🕊️ Dove is a Jekyll theme development project. We are currently working on the following themes.

• techie-joe/core
• techie-joe/mallet
• techie-joe/prime

Get a quick and easy way to build a website. Build your website on GitHub Pages using ready-to-go templates and components. You can use Markdown, Pug or HTML to code your website. Set and style any page instantly, just by referring to our pre-configured assets. Should you require any further personalization, you can customize every detail as needed, from global defaults to specific components.

We handles the necessary foundation so you can focus on your code.

Warning

Dove is constantly under active development. Beta builds may break your site without you noticing. Do not use them directly. Instead, visit individual theme's homepage for a stable release.

How to use

To use the theme on your site:

1. Add the following lines to the _config.yml file at the root of your site's repository:

   remote_theme: techie-joe/dove
   plugins:
       - jekyll-remote-theme

2. Clear out any existing values of theme.

3. Then, activate GitHub Pages for your site.

For detailed instruction, see The GitHub Pages Walkthrough.

How to customize

Configuration variables

Set the following variables in your site's _config.yml file.

title       : "The title of your site"
description : "Short description of your site."

Additionally, you may also set:

ghost: your-tracking-id
# to track your ThemeJs.

google_analytics: your-tracking-id
# to track your website using Google Analytics.

cloudflare_analytics: your-tracking-id
# to track your website using Cloudflare Analytics.

show_downloads: true
# true or false (unquoted).
# to indicate whether to provide a download URL.

Stylesheet

To add your own custom styles:

1. Create a file called /assets/css/style.scss in your site's repository with the following content, exactly as shown:

   ---
   ---
   @import "dove";

2. Add any custom styles immediately after the @import line.

Note: To change the theme's SASS variables, you must set new values before the @import line in your stylesheet.

Layouts

All theme layouts in the _layouts folder and theme components in the _includes folder provide a good starting point of things you can customize. To override a file, create a mirror copy of that file in your site's repository reflecting the exact path and file-name.

For example, to change the default layout:

1. Copy the /_layouts/default.html file to your site's repository.
2. Then customize it as you'd like.

Pro-tip: click "raw" to make copying easier.

Analytics code

Paste the analytics code into your site's _includes/google_analytics.html file.

Overriding GitHub values

The theme rely on GitHub values, such as links to your repository or links to download your project.

To override the default values:

1. Look at the theme source file (in the _layouts and _includes folder) to determine the name of the variable. It will be in the form of:

   {% raw %}

   {{ site.github.zip_url }}

   {% endraw %}

2. Specify the value you'd like to use in your site's _config.yml file. Jekyll will use the value you specified, instead of the default one.

   For example, if the variable was site.github.zip_url, add the following:

   github:
       zip_url: http://example.com/download.zip
       # another_url: another_value

   Note: Ignore the site. prefix, and maintain the two space indent for each sub variables.

For more information, see Jekyll documentation on Variables.

Running the theme locally

To run the theme locally:

1. Clone the theme's repository into your computer:

   git clone https://github.com/techie-joe/dove
   

2. Go to the cloned directory.

3. Add the following code to your site's Gemfile:

   gem "github-pages", group: :jekyll_plugins

4. Run script/bootstrap to install necessary dependencies.

   This is a required one-time setup before other script can function.

5. Then run script/serve to start the server.

6. Visit localhost:4000 in your browser to see the template.

Running tests

This project contains a minimal test suite, to ensure a site with the theme would build successfully.

To run the tests:

1. Run script/bootstrap to install necessary dependencies.

   This is a required one-time setup before other script can function.

2. Then run script/cibuild to start the test.

Contributing

Interested in contributing to the Dove project? We'd love your help. Dove is an open source project, built one contribution at a time by users like you. Go ahead and start a discussion.

Roadmap

See the open issues for a list of proposed features and known issues.

License

Dove is an open source project licensed under the MIT LICENSE. You're allowed to use the code with conditions only requiring preservation of copyright and license notices.