README.md

   1 # Editorial
   2
   3 This is Editorial, a news-oriented design built around a dynamic 'locking' sidebar (try the toggle to see it in action!) and purpose built for content-centric sites. Originally created by [@ajlkn](https://twitter.com/ajlkn) for [HTML5 UP](https://html5up.net) and later ported to [Ghost](https://ghost.org)
   4
   5 **Demo: https://editorial.ghost.io**
   6
   7 &nbsp;
   8
   9 ![screenshot](https://user-images.githubusercontent.com/120485/49328081-0e192680-f59d-11e8-808a-e6d6bcfa8419.png)
  10
  11
  12 &nbsp;
  13
  14 # First time using a Ghost theme?
  15
  16 Ghost uses a simple templating language called [Handlebars](http://handlebarsjs.com/) for its themes.
  17
  18 We've documented our default theme pretty heavily so that it should be fairly easy to work out what's going on just by reading the code and the comments. Once you feel comfortable with how everything works, we also have full [theme API documentation](https://themes.ghost.org) which explains every possible Handlebars helper and template.
  19
  20 **The main files are:**
  21
  22 - `default.hbs` - The main template file
  23 - `index.hbs` - Used for the home page
  24 - `post.hbs` - Used for individual posts
  25 - `page.hbs` - Used for individual pages
  26 - `tag.hbs` - Used for tag archives
  27 - `author.hbs` - Used for author archives
  28
  29 One neat trick is that you can also create custom one-off templates just by adding the slug of a page to a template file. For example:
  30
  31 - `page-about.hbs` - Custom template for the `/about/` page
  32 - `tag-news.hbs` - Custom template for `/tag/news/` archive
  33 - `author-ali.hbs` - Custom template for `/author/ali/` archive
  34
  35
  36 # Development
  37
  38 This implementation tries to stay as true as possible to the original template without making too many modifications. The original code is unmodified, preserving the ability to update it later.
  39
  40 There are two main changes compared to the original template files:
  41
  42 - The original template contained separate `/assets` and `/images` directories. Ghost Themes require that all assets be nested under a top-level `/assets` directory, so these are moved to `/assets/main` and `/assets/images`, respectively.
  43 - In order to make minor modifications and add some new custom styles, one additional SaSS file is added under `/assets/main/sass/layout/ghost.sass` and included at the bottom of the `main.sass` file.
  44
  45 To work on styles in this theme, you'll need to run a local development environment to build/watch for changes. Once cloned and installed with npm/yarn, the following `gulp` build tasks are available:
  46
  47 ```bash
  48 # Build files locally and watch for changes
  49 gulp
  50
  51 # Build production zip locally and save to /dist
  52 gulp zip
  53
  54 # Run compatibility test against latest version of Ghost
  55 yarn test
  56 ```
  57
  58 Original template files and design by [@ajlkn](https://twitter.com/ajlkn)
  59
  60
  61 # Copyright & License
  62
  63 Copyright (c) 2013-2020 [HTML5 UP](https://htmlup.net) & [Ghost Foundation](https://ghost.org) - This theme is licensed under both the [MIT and Creative Commons Attribution 3.0](LICENSE). Please note that the terms of the Creative Commons license require that you maintain the footer attribution to freely use this theme.