mirror of
https://github.com/MinimalBible/MinimalBible.github.io
synced 2024-12-21 06:08:19 -05:00
Merge branch 'hotfix/updates'
This commit is contained in:
Michael Rose
commit
cd9f912242
15
README.md
15
README.md
@ -5,7 +5,7 @@ They say three times the charm, so here is another free responsive Jekyll theme
|
||||
## What HPSTR brings to the table:
|
||||
|
||||
* Responsive templates for post, page, and post index `_layouts`. Looks great on mobile, tablet, and desktop devices.
|
||||
* Gracefully degrads in older browsers. Compatible with Internet Explorer 8+ and all modern browsers.
|
||||
* Gracefully degrades in older browsers. Compatible with Internet Explorer 8+ and all modern browsers.
|
||||
* Modern and minimal design.
|
||||
* Sweet animated menu.
|
||||
* Readable typography to make your words shine.
|
||||
@ -24,7 +24,7 @@ They say three times the charm, so here is another free responsive Jekyll theme
|
||||
|
||||
---
|
||||
|
||||
General notes and suggestions for customizing **HPSTR RDX**.
|
||||
General notes and suggestions for customizing **HPSTR**.
|
||||
|
||||
## Basic Setup for a new Jekyll site
|
||||
|
||||
@ -33,7 +33,7 @@ General notes and suggestions for customizing **HPSTR RDX**.
|
||||
3. Clone the repo you just forked to your computer.
|
||||
4. Edit `_config.yml` to personalize your site.
|
||||
5. Check out the sample posts in `_posts` to see examples for pulling in large feature images, tags, and other YAML data.
|
||||
6. Read the documentation below for further customization pointers and documentation.
|
||||
6. Read the documentation below for additional customization pointers and documentation.
|
||||
|
||||
[Download the Theme](https://github.com/mmistakes/hpstr-jekyll-theme)
|
||||
|
||||
@ -51,7 +51,10 @@ General notes and suggestions for customizing **HPSTR RDX**.
|
||||
title: Site Title
|
||||
description: Describe your website here.
|
||||
disqus_shortname: shortname
|
||||
url: http://your-website.com
|
||||
# Your site's domain goes here. When working locally use localhost server leave blank
|
||||
# PS. If you set this wrong stylesheets and scripts won't load and most links will break.
|
||||
# PPS. If you leave it blank for local testing home links won't work, they'll be fine for live domains though.
|
||||
url: http://localhost:4000
|
||||
|
||||
# Owner/author information
|
||||
owner:
|
||||
@ -100,7 +103,7 @@ paginate: 5
|
||||
|
||||
## More Theme Setup Goodness
|
||||
|
||||
To learn more about how to customize the theme, how feature images work, use the Grunt build script, and some other junk, [read up here](http://mmistakes.github.io/hpstr-jekyll-theme/theme-setup/).
|
||||
To learn more about how to customize the theme, include feature images in posts, use the Grunt build script, and some other junk, [read up here](http://mmistakes.github.io/hpstr-jekyll-theme/theme-setup/).
|
||||
|
||||
---
|
||||
|
||||
@ -112,4 +115,4 @@ Having a problem getting something to work or want to know why I setup something
|
||||
|
||||
## License
|
||||
|
||||
This theme is free and open source software, distributed under the [GNU General Public License](https://github.com/mmistakes/hpstr-jekyll-theme/blob/master/LICENSE) version 2 or later. So feel free to use this Jekyll theme on your site without linking back to me or including a disclaimer.
|
||||
This theme is free and open source software, distributed under the [GNU General Public License](https://github.com/mmistakes/hpstr-jekyll-theme/blob/master/LICENSE) version 2 or later. So feel free to to modify this theme to suit your needs.
|
||||
|
||||
@ -18,4 +18,4 @@
|
||||
})();
|
||||
</script>
|
||||
{% endif %}
|
||||
{% if site.disqus_shortname and page.comments %}{% include disqus_comments.html %}{% endif %}
|
||||
{% if page.comments %}{% include disqus_comments.html %}{% endif %}
|
||||
@ -39,7 +39,10 @@ General notes and suggestions for customizing **HPSTR**.
|
||||
title: Site Title
|
||||
description: Describe your website here.
|
||||
disqus_shortname: shortname
|
||||
url: http://your-website.com
|
||||
# Your site's domain goes here. When working locally use localhost server leave blank
|
||||
# PS. If you set this wrong stylesheets and scripts won't load and most links will break.
|
||||
# PPS. If you leave it blank for local testing home links won't work, they'll be fine for live domains though.
|
||||
url: http://localhost:4000
|
||||
|
||||
# Owner/author information
|
||||
owner:
|
||||
@ -123,7 +126,7 @@ hpstr-jekyll-theme/
|
||||
|
||||
### _config.yml
|
||||
|
||||
Most of the variables found here are used in the .html files found in `_includes` if you need to add or remove anything. A good place to start would be to add the `title`, `description`, and `url` for your site. Links are absolute and prefixed with `{{ "{{ site.url " }}}}` in the various `_includes` and `_layouts`, so remember to comment out `url`[^1] when working locally to avoid broken links.
|
||||
Most of the variables found here are used in the .html files found in `_includes` if you need to add or remove anything. A good place to start would be to add the `title`, `description`, and `url` for your site. Links are absolute and prefixed with `{{ "{{ site.url " }}}}` in the various `_includes` and `_layouts`, so remember to properly set `url`[^1] to `http://localhost:4000` when developing locally.
|
||||
|
||||
#### Disqus Comments
|
||||
|
||||
@ -174,7 +177,7 @@ image:
|
||||
background: filename.png
|
||||
{% endhighlight %}
|
||||
|
||||
This little bit of YAML makes the assumption that your background image asset is in the `/images` folder. If you place it somewhere else or are hotlinking from the web, just include the full http(s):// URL. Either way you should have a background image that is tiled.
|
||||
This little bit of YAML makes the assumption that your background image asset is in the `/images` folder. If you place it somewhere else or are hot linking from the web, just include the full http(s):// URL. Either way you should have a background image that is tiled.
|
||||
|
||||
If you want to set a background image for the entire site just add `background: filename.png` to your `_config.yml` and BOOM --- background images on every page!
|
||||
|
||||
@ -261,10 +264,10 @@ Having a problem getting something to work or want to know why I setup something
|
||||
|
||||
## License
|
||||
|
||||
This theme is free and open source software, distributed under the [GNU General Public License]({{ site.url }}/LICENSE) version 2 or later. So feel free to use this Jekyll theme on your site without linking back to me or including a disclaimer.
|
||||
This theme is free and open source software, distributed under the [GNU General Public License]({{ site.url }}/LICENSE) version 2 or later. So feel free to to modify this theme to suit your needs.
|
||||
|
||||
---
|
||||
|
||||
[^1]: Used to generate absolute urls in `sitemap.xml`, `feed.xml`, and for canonical urls in `head.html`. Don't include a trailing `/` in your base url ie: http://mademistakes.com. When developing locally remove or comment out this line so local CSS, JS, and image assets are used.
|
||||
[^1]: Used to generate absolute urls in `sitemap.xml`, `feed.xml`, and for canonical urls in `head.html`. Don't include a trailing `/` in your base url ie: http://mademistakes.com. When developing locally I suggest using http://localhost:4000 or whatever localhost you're using to properly load all theme stylesheets, scripts, and image assets. If you leave this variable blank all links will resolve correctly except those pointing to home.
|
||||
|
||||
[^2]: If you're using GitHub Pages to host your site be aware that plugins are disabled. So you'll need to build your site locally and then manually deploy if you want to use this sweet plugin.
|
||||
Loading…
Reference in New Issue
Block a user