BearChao / Ease

A minimal documentation theme for Ghost

Ease

A versatile theme suitable for documentation. Publish your posts or business information with ease. Completely free and fully responsive, released under the MIT license.

Demo: https://ease.ghost.io

 

Instructions

1. Download this theme
2. Log into Ghost, and go to the Design settings area to upload the zip file

Search

1. Generate a content API key in Integrations section which will be used to fetch posts from your site.
2. Insert the generated key in Code injection > Site Header field.

<script>
    var gh_search_key = 'API_KEY';
    var gh_search_migration = 'v1';
</script>

The theme generates an index of posts for highly performant search. The index is updated automatically when posts are added or updated. However, it isn't updated when posts are unpublished or deleted.

To force update the index, increment the search index migration version like 'v2'.

Development

Styles are compiled using Gulp/PostCSS to polyfill future CSS spec. You'll need Node, Yarn and Gulp installed globally. After that, from the theme's root directory:

# Install
yarn

# Run build & watch for changes
$ yarn dev

Now you can edit /assets/css/ files, which will be compiled to /assets/built/ automatically.

The zip Gulp task packages the theme files into dist/<theme-name>.zip, which you can then upload to your site.

yarn zip

PostCSS Features Used

• Autoprefixer - Don't worry about writing browser prefixes of any kind, it's all done automatically with support for the latest 2 major versions of every browser.

Copyright & License

Copyright (c) 2013-2020 Ghost Foundation - Released under the MIT license.