Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drjekyllthemes/themes
Dr. Jekyll's Themes - Add Your Theme!
https://github.com/drjekyllthemes/themes
jekyll jekyll-themes static-site
Last synced: 5 days ago
JSON representation
Dr. Jekyll's Themes - Add Your Theme!
- Host: GitHub
- URL: https://github.com/drjekyllthemes/themes
- Owner: drjekyllthemes
- License: cc0-1.0
- Created: 2014-12-20T14:39:20.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-11-02T08:24:27.000Z (about 1 year ago)
- Last Synced: 2024-12-06T16:11:31.813Z (17 days ago)
- Topics: jekyll, jekyll-themes, static-site
- Language: HTML
- Homepage:
- Size: 9.57 MB
- Stars: 98
- Watchers: 4
- Forks: 73
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Dr. Jekyll's Themes - Add Your Theme!
(Yet Another) Static Website Theme Directory - see it live @ [`drjekyllthemes.github.io`](http://drjekyllthemes.github.io)
## How-To Add Your Theme
First fork the [`/themes` repo](https://github.com/drjekyllthemes/themes) on GitHub.
### Step 1: Add a new entry in the `themes.yml`datafile
Add a new entry in the [`themes.yml`](https://github.com/drjekyllthemes/themes/blob/master/themes.yml) datafile
and fill out all fields. Example:
``` yaml
- 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)
``` yaml
- 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](http://drjekyllthemes.github.io/themes)
auto-built with every commit / pull request merge.
Note: For the Dr Jekyll's website itself (see [source](https://github.com/drjekyllthemes/drjekyllthemes.github.io)) the `themes.yml` has to run through build steps (see [source](https://github.com/yorobot/planetjekyll))
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](http://groups.google.com/group/wwwmake). Thanks!