DocsFormatRoutes Setup

Routes Setup

To upload the routes.yaml follow these steps:

  1. Unzip the format.zip theme file
  2. Go to Settings β†’ Advanced β†’ Labs
  3. Click Open β†’ Beta features
  4. Under Routes section, click Upload routes file button
  5. Select and upload the routes.yaml file from the theme folder

Ghost routes settings

Note: upload routes.yaml after uploading the theme zip.
There will already be a default routes.yaml file uploaded to Ghost. You must upload your theme’s routes.yaml to override the default.

Do this separately after uploading your theme zip file.

The routes.yaml is required to properly map the custom routes provided by the theme:

  • /writings/ - List of all posts
  • /signup/ - Sign up page
  • /signin/ - Sign in page
  • /tag/*/ - List of all posts with the tag
  • /author/*/ - List of all posts by the author and author’s bio

Custom Pages Data

Our theme provides a few custom pages. However, to modify the page title, image, excerpt, and content, you need to activate the data property. To do so, you must remove the # symbol in front of the data property in the routes.yaml file. Then, create the page with the correct slug that you wish to control.

For instance, if you want to manage the /projects/ page, create a page with the slug projects. After that, fill in the data property in the routes.yaml file:

collections:
    ...
    /writings/:
        permalink: /{slug}/
        template: writings
        data: page.writings # When active data will be taken from the  "/writings/" page