cupper-hugo-theme/exampleSite/content/patterns/updating.md
2019-01-31 18:19:20 -06:00

1.6 KiB

+++ title = "Updating Cupper" weight = 5 +++

The core of Cupper's functionality is in its Hugo theme, also called Cupper. This is found in the theme folder.

{{% fileTree %}}

  • content
  • docs
  • lib
  • snippets
  • static
  • themes
    • cupper {{% /fileTree %}}

Do not "hack the core". If you have any issues with Cupper, please report them to the Cupper Github repository and they will be dealt with ASAP.

Cupper is undergoing constant development, so keep an eye out for new releases. To update to a new version of Cupper, simply run the update command from inside your local project folder.

{{}} npm run update {{}}

This will save a timestamped backup of the current version, and download the latest version. Your theme folder will now look something like the following.

{{% fileTree %}}

  • themes
    • cupper
    • cupper-old-1503389765972 {{% /fileTree %}}

If you experience breaking changes and are having trouble fixing them, you can rename the old folder and revert to using it. In the meantime, you can submit an issue with the "help" tag describing your problem.

{{% warning %}} The described update process relies on SVN because Github does not support downloading individual repository folders. If you have a Mac, SVN should be installed already. If not, or if you are on Windows, you can either install SVN or download the latest Cupper theme folder manually, using the Github web interface. {{% /warning %}}