I’m not a developer or designer. And I don’t add footer to show who did this theme. If you like this theme or using it, please give a star for motivation, It makes me happy.
Installation
- Fork the Moon repo
- Edit
_config.yml
file. - Remove sample posts from
_posts
folder and add yours. - Edit
index.md
file inabout
folder. - Change repo name to
YourUserName.github.io
That’s all.
Preview
See a live version of Moon hosted on GitHub.
Site Setup
A quick checklist of the files you’ll want to edit to get up and running.
Site Wide Configuration
_config.yml
is your friend. Open it up and personalize it. Most variables are self explanatory but here’s an explanation of each if needed:
title
The title of your site… shocker!
Example title: My Awesome Site
bio
The description to show on your homepage.
description
The description to use for meta tags and navigation menu.
url
Used to generate absolute urls in sitemap.xml
, feed.xml
, and for generating canonical URLs in <head>
. When developing locally either comment this out or use something like http://localhost:4000
so all assets load properly. Don’t include a trailing /
.
Examples:
reading_time
Set true to show reading time for posts. And set words_per_minute
, default is 200.
logo
Your site’s logo. It will show on homepage and navigation menu. Also used for twitter meta tags.
background
Image for background. If you don’t set it, color will be used as a background.
Google Analytics and Webmaster Tools
Google Analytics UA and Webmaster Tool verification tags can be entered in _config.yml
. For more information on obtaining these meta tags check Google Webmaster Tools and Bing Webmaster Tools support.
MathJax
It’s enabled. But if you don’t want to use it. Set it false in _config.yml
.
Disqus Comments
Set your disqus shortname in _config.yml
to use comments.
Navigation Links
To set what links appear in the top navigation edit _data/navigation.yml
. Use the following format to set the URL and title for as many links as you’d like. External links will open in a new window.
Layouts and Content
Moon Theme use Jekyll Compress to compress html output. But it can cause errors if you use “linenos” (line numbers). I suggest don’t use line numbers for codes, because it won’t look good with this theme, also i didn’t give a proper style for them. If you insist to use line numbers, just remove layout: compress
string from layouts. It will disable compressing.
Feature Image
You can set feature image per post. Just add feature: some link
to your post’s front matter.
feature: /assets/img/some-image.png
or
feaure: http://example.com/some-image.png
This also will be used for twitter card:
Comments
To show disqus comments for your post add comments: true
to your post’s front matter.
Questions?
Found a bug or aren’t quite sure how something works? By all means file a GitHub Issue. And if you make something cool with this theme feel free to let me know.
License
This theme is free and open source software, distributed under the MIT License. So feel free to use this Jekyll theme on your site without linking back to me or including a disclaimer.