Skip to content

Commit

Permalink
v1.0.4 Readme update
Browse files Browse the repository at this point in the history
update readme v1.0.4

version bump

get all posts

ignore rocketloader
  • Loading branch information
oscarmorrison committed Jan 9, 2017
1 parent 4d2309f commit 561a381
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 3 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ fork of the [Lanyon-Ghost](https://github.com/PxlBuzzard/lanyon-ghost) Theme.
This theme is ideal for single author, tag heavy, looking for a simple design, with code highlighting.

### Updates
- v1.0.4 (8 Jan 16)
- Add ability to config features
- Add tag sub menu
- v1.0.3 (4 Jan 16)
- Support additional language for syntax highlighting (Go, Python, MD)
- v1.0.2 (3 Dec 16)
Expand All @@ -26,7 +29,9 @@ This theme is ideal for single author, tag heavy, looking for a simple design, w
Support for [Ghost 0.8.0](https://dev.ghost.org/ghost-0-8-0/

## Features
- Configurable Features
- Custom Navigation Menu ([#7](https://github.com/oscarmorrison/oscar-ghost/issues/7))
- Submenu for tags ([#20](https://github.com/oscarmorrison/oscar-ghost/pull/20))
- [Prism.js](http://prismjs.com) Code Highlighting (Markup, Bash, Swift, JS, C, Go, Python...)
- Font: [Lato](https://www.google.com/fonts/specimen/Lato) weights 100,300,300italic
- Automatic internal and external linking
Expand All @@ -40,6 +45,24 @@ This theme is ideal for single author, tag heavy, looking for a simple design, w


## Customization

### Configuration
I have included with v1.0.4 a way to do some basic feature configuration that is often asked for:
These are the default values (found in oscar.js):
```
let oscar = {
animatedNav: true,
tagMenu: true,
tagKey: '#tagnav',
requirePosts: false
};
```

**animatedNav:** if the nav auto hides, or is shown
**tagMenu:** if the secondary tag menu is shown
**tagKey:** what the custom key to look for in the tag description is. (this can be any string)
**requirePosts:** show only tags that have posts in them

### Navigation
![NavBar](http://blogoscarmorrison.s3.amazonaws.com/2016/Dec/navigationBar.png)
The navigation menu can be customize through the [ghost admin](https://blog.ghost.org/navigation/),
Expand Down
2 changes: 1 addition & 1 deletion assets/js/oscar.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ $('a[href^=http]').each(function(){
});

if(location.pathname === '/' && oscar.tagMenu) {
$.get(ghost.url.api('tags', {include: 'count.posts', order: 'count.posts DESC'}))
$.get(ghost.url.api('tags', {limit: 'all', include: 'count.posts', order: 'count.posts DESC'}))
.then(function(data) {
var navTags = data.tags.filter(function(tag){
return (oscar.requirePosts
Expand Down
2 changes: 1 addition & 1 deletion default.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.2.3/jquery.min.js"></script>
<script type="text/javascript" src="{{asset 'js/gallery.js'}}"></script>
<script type="text/javascript" src="{{asset 'js/prism.js'}}"></script>
<script type="text/javascript" src="{{asset 'js/oscar.js'}}"></script>
<script type="text/javascript" src="{{asset 'js/oscar.js'}}" data-cfasync="false"></script>
{{! Ghost outputs important scripts and data with this tag }}
{{ghost_foot}}
</body>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"name": "oscar-ghost",
"author": "Oscar Morrison",
"description":"A clean minimal ghost theme",
"version": "1.0.3"
"version": "1.0.4"
}

0 comments on commit 561a381

Please sign in to comment.