The code of the theme is divided in 3 main sections: static files (as HTML and images), CSS and JS. Check out the folders tree:
.
├── LICENSE.md
├── README.md
├── assets
│ ├── css
│ │ └── uno-zen.css # the production css
│ ├── fonts
│ ├── img # favicons and cover image
│ ├── js
│ │ ├── src
│ │ │ ├── __init.coffee
│ │ │ ├── cover.coffee
│ │ │ ├── main.coffee
│ │ │ └── search.coffee
│ │ └── uno-zen.js # the production js
│ └── scss
│ │ ├── components # specific stuff
│ │ │ ├── _aside.scss
│ │ │ ├── _loading.scss
│ │ │ ├── _media-queries.scss
│ │ │ ├── _page-error.scss
│ │ │ ├── _pagination.scss
│ │ │ ├── _post.scss
│ │ │ └── _search.scss
│ │ ├── modules # basic stuff
│ │ │ ├── _buttons.scss
│ │ │ ├── _effects.scss
│ │ │ ├── _fonts.scss
│ │ │ ├── _forms.scss
│ │ │ ├── _global.scss
│ │ │ ├── _grid.scss
│ │ │ ├── _mixins.scss
│ │ │ ├── _reset.scss
│ │ │ └── _variables.scss
│ │ └── uno.scss # main file to create the CSS
| └── vendor # frontend dependencies
├── bower.json
├── default.hbs
├── error.hbs
├── gulpfile.coffee
├── index.hbs
├── node_modules
├── package.json
├── partials # different partials view
│ ├── aside.hbs
│ ├── comments.hbs
│ ├── footer.hbs
│ ├── google-analytics.hbs
│ ├── links.hbs
│ ├── meta.hbs
│ ├── pagination.hbs
│ ├── search.hbs
│ └── social.hbs
├── post.hbs
└── tag.hbs
Putting the files in context:
- The JS inside
assets/js/srcis compiled intoassets/js/uno.js - The SCSS (we use SASS) inside
assets/scssis compiled intoassets/css/uno.css - We have some static files like
post.hbs,tag.hbs,default.hbs,index.hbs,... the partials views insideassets/partialsis used in this views.
For do it automatically and easily we use Gulp, check gulpfile.coffee for know how to we do it.
For local development you need to have a locally Ghost server, like this:
node index.js
Migrations: Up to date at version 003
Ghost is running in development...
Listening on 127.0.0.1:2387
Url configured as: http://127.0.0.1:2387
Ctrl+C to shut downNote that my local Ghost is running in the port 2387.
With your local Ghost running, open another terminal and enter in the folder content/themes of your local Ghost and clone the theme repository and install the dependencies for local development:
$ git clone https://github.com/Kikobeats/uno-zen && cd uno-zen && npm install && bower installJust run gulp command in the theme terminal. Now you have a development scenario, and looks like this:
With the gulp command you are automatically launching the task for compile the assets and reload the server when your assets change. For do it we uses BrowserSync that is setup as middleware between the theme and the Ghost. You can connect different devices and try the responsive of the website as well.
As the screenshot, you need to use for the proxying the same port as your Ghost server. If your Ghost server is in a different port than 2387 you need to modify gulpfile.coffee and put the correct port.
The code highlight is based in Prism. By default, the languages supported are:
markup, css, c, javascript
If you want to support more languages:
- go to prismjs.com/download,
- generate your custom highlight code
- paste in the prism file
- compile the assets
Be careful, the current prism code is integrated with the color schema of the theme. You need to edit manually to get the correct look and feel.
Go to Ghost Admin Panel → Code Injection → Blog Header and add:
<script>
var ga_id = 'UA-YOUR_ID_HERE';
</script>Go to Ghost Admin Panel → Code Injection → Blog Header and add:
<script>
var disqus_shortname = 'YOUR_DISQUS_SHORTCUT_HERE';
</script>By default, the open buttons works binding the event of open the blog with a button called 'Posts' created into Ghost Navigation section. Here is the piece of code that create the bind:
var openButton = window.open_button || '.nav-posts > a'As you see, you can specify a different button selector. For example, if You want to open your blog under 'Blog' button, then you add this in Admin Panel → Code Injection → Blog Header:
<script>
var open_button = '.nav-blog > a'
</script>By default, the title that you see in the open page of your blog is extracted from your blog settings (Admin Panel → Blog Title).
If you want to customize it, you can do it:
Go to Ghost Admin Panel → Code Injection → Blog Header and add:
<script>
var profile_title = 'Kiko Beats';
</script>The purpose of the subtitle is resume the bio in a phrase. This will be shown in the mobile/tablet version instead of the bio.
Go to Ghost Admin Panel → Code Injection → Blog Header and add:
<script>
var profile_resume ='Software Engineer';
</script>Edit the file assets/scss/modules/_variables.scss. Remember that is necessary compile the build to load the new style, so keep running your gulp process in background.
Edit the file partials/social.hbs.
Go to Ghost Admin Panel → Navigation and add/edit items.
"Blog" link is always included by default, so you don't need to add it manually.
Create your favicons with Favicon Generator and puts it in assets/img.
Go to Ghost Admin Panel → General → Blog Cover
The linear gradient of the cover filter is based in $cover-primary and $cover-secondary colors. If you want to adapt the filter for your cover, check background-filter mixin.
Check the page part in the Ghost Official Documentation.
You can enable the multiaccount support editing posts.hbs code commented inside the meta post information.
When you consider that the development is done and you want to deploy a new version, package your code using gulp build command, that minify and concatenate all necessary code.