Dr. Jekyll's Themes - Add Your Theme!
Switch branches/tags
Nothing to show
Clone or download
Permalink
Failed to load latest commit information.
test use remote theme Feb 14, 2018
thumbnails Add jekyll-theme-mint Sep 19, 2018
.gitignore Add .gitignore for _site directory Jun 26, 2018
LICENSE.md Create LICENSE.md Mar 21, 2017
README.md up Feb 13, 2018
_config.yml use remote theme Feb 14, 2018
themes.yml Add jekyll-theme-mint Sep 19, 2018
themes_404.yml up moved permanently Feb 16, 2018
themes_duplicates.yml up Feb 13, 2018
themes_i.yml up Feb 19, 2018
themes_ii.yml up Feb 13, 2018

README.md

Dr. Jekyll's Themes - Add Your Theme!

(Yet Another) Static Website Theme Directory - see it live @ drjekyllthemes.github.io

How-To Add Your Theme

First fork the /themes repo on GitHub.

Step 1: Add a new entry in the themes.ymldatafile

Add a new entry in the themes.yml datafile and fill out all fields. Example:

- name:      Basically Basic
  github:    mmistakes/jekyll-theme-basically-basic
  branch:    master                              ## note: defaults to master; only needed for gh-pages
  demo_url:  https://mmistakes.github.io/jekyll-theme-basically-basic
  author:    Michael Rose
  thumbnail: basicallybasic.png
  license:   MIT
  gem:       jekyll-theme-basically-basic         ## optional
  tags:     [minimal, responsive, blog, resume]   ## optional

or (without the github+branch shortcuts)

- name:         Basically Basic
  home_url:     https://github.com/mmistakes/jekyll-theme-basically-basic
  download_url: https://github.com/mmistakes/jekyll-theme-basically-basic/archive/master.zip
  demo_url:     https://mmistakes.github.io/jekyll-theme-basically-basic
  author:       Michael Rose
  thumbnail:    basicallybasic.png
  license:      MIT
  gem:          jekyll-theme-basically-basic         ## optional
  tags:        [minimal, responsive, blog, resume]   ## optional

Step 2 - Add a 250 x 200 thumbnail (screenshot preview pic) in the thumbnails folder

Make a 250 x 200 thumbnail and drop it in the thumbnails folder. Example: thumbnails/basicallybasic.png (250 x 200 px)

Note: Do NOT forget to list its filename in the themes.yml entry.

Step 3 - Send a pull request

Check that everything is ok, then open up a pull request.

That's it. Thanks!


Frequently Asked Questions 'n' Answers

Q: I added my theme why is it not displaying on the website. Can you please take a look?

A: Thanks for your patience. You can double check and see your theme on the Themes Quick Test Page auto-built with every commit / pull request merge.

Note: For the Dr Jekyll's website itself (see source) the themes.yml has to run through build steps (see source) to get github stars 'n' history etc. and, sorry, for now this is still a manual task / procedure that will get done "by hand". For your theme to show up, thus, please wait for the next site update.

Tips & Tricks

Q: How to create a 250 x 200 thumbnail?

A: One way is to create a regular-size screenshoot e.g. 1024 x 768 in step one. In step two calculate how much to zoom in (divide the required width, that is, 250 pixel by your current width, that is, 1024 pixel) e.g.

 250
---- * 100 =  24.4 %
1024

Than readjust the scale to 24.4% and set the width and height to 250 x 200. That's it.

Another example - let's say the screenshoot size is 500 x 400 using the formula calculate how much to zoom in e.g.

 250
---- * 100 =  50 %
 500

License

The themes directory is dedicated to the public domain. Use it as you please with no restrictions whatsoever.

Questions? Comments?

Post them to the wwwmake forum. Thanks!