Skip to content

Commit

Permalink
feat(docs): added a migration guide between releases
Browse files Browse the repository at this point in the history
  • Loading branch information
bigbrozer committed Sep 10, 2023
1 parent d5a08c0 commit 64d5d1e
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Contents:
* [Adding a post index page](#adding-a-post-index-page)
* [Theme settings](#theme-settings)
* [Acknowledgements](#acknowledgements)
* [Updates](#updates)
* [Updating from v0.2.0](#updating-from-v020)
* [License](#license)

## Getting Started
Expand All @@ -27,13 +29,13 @@ Once the theme is installed, read following sections to know how to use and conf

### Adding a portfolio image

The portfolio (on homepage) is composed of posts with only a `title`, a `featured image` and ensure `Other options ➔ Post template ➔ Image for the portfolio` is set.
The portfolio (on homepage) is composed of posts with only a `title`, a `featured image`, has `Status ➔ Hide Post` set to true and ensure `Other options ➔ Post template ➔ Image for the portfolio` is set.

This combination will show the picture with a lightbox effect. The `title` is used as the image caption.

### Adding a post index page

To generate a post index page where you can list all available posts, create a new post with a title like **Post index**, hide it and tag it `post-index`.
To generate a post index page where you can list all available posts, create a new post with a title like **Post index**, select `Status ➔ Hide Post`, tag it as `post-index` and ensure you use template `Other options ➔ Post template ➔ Show the index of all posts`.

You will see a link appearing below the **Readings** section from homepage to access the post index page.

Expand All @@ -48,6 +50,15 @@ From Publii, navigate to `Theme ➔ Custom settings` to customize the theme beha
* [UIKit](https://getuikit.com/) -- UIkit is a lightweight and modular front-end framework for developing fast and powerful web interfaces.
* [Release It!](https://github.com/release-it/release-it) -- Generic CLI tool to automate versioning and package publishing-related tasks.

## Updates

As this is a pre-release (below v1.x), sometime the theme will need some adaptations when upgrading. Follow the guide !

### Updating from v0.2.0

* In **Theme** menu on the left, enter the **Custom settings** area and set `Sidebar ➔ Number of posts: 2`. Save settings.
* From this release, you must hide all portfolio posts by enabling `Status ➔ Hide Post` in order to show them on the homepage.

## License

See [LICENSE](./LICENSE).

0 comments on commit 64d5d1e

Please sign in to comment.