Comics is a Jekyll Theme inspired by action comics. You can preview the theme to see what it looks like, or even use it today.*
First, follow the steps in this Quickstart Guide if you're starting with Jekyll from scratch. Skip this if you already have an existing jekyll project.
-
Clone the repository:
git clone https://github.com/username/jekyll-theme-comics
-
Run
bundle install
-
Run Jekyll:
jekyll serve -w
-
Go to http://localhost:4000 for your site.
-
Edit
_config.yml
, then rerunjekyll serve -w
-
Change
about.md
for blog intro -
For domain settings see the guide from GitHub
To use the comics theme on github pages:
-
Add the following to your site's
_config.yml
:remote_theme: r01nx/jekyll-theme-comics plugins: - jekyll-remote-theme # add this line to the plugins list if you already have one
-
Optionally, if you'd like to preview your site on your computer, add the following to your site's
Gemfile
:gem "github-pages", group: :jekyll_plugins
Comics will respect the following variables, if set in your site's _config.yml
:
title: [The title of your site]
description: [A short description of your site's purpose]
If you'd like to add your own custom styles:
- Create a file called
/assets/css/style.scss
in your site - Add the following content to the top of the file, exactly as shown:
--- --- @import "{{ site.theme }}";
- 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.
If you'd like to change the theme's HTML layout:
- For some changes you can add custom files in your local
_includes
folder. The files provided with the themeprovide a starting point and are included by the [original layout template] - Create a file called
/_layouts/default.html
in your site - Paste the default layout content copied in the first step
- Customize the layout as you'd like
See the open issues for a list of proposed features (and known issues).
The Comics theme originated from the idea of presenting a page with a colorscheme that excites the vision. It is intended to make it quick and easy for users to create a website. The theme is perfect for exciting projects, erring on the side of simplicity rather than flexibility, and provide users the opportunity to opt-in to additional complexity if they have specific needs or wish to further customize their experience (such as adding custom CSS or modifying the default layout). It should also look great, but that goes without saying.
Interested in contributing to Comics? I'd love your help. Comics is an open source project.
Open sourced under the MIT license.
<3