Jekyll collections

Learn how to create a Jekyll collection to add a new primary section on Braze Docs. For more information, see Jekyll Collections.

Prerequisites

If you haven’t already, complete the steps for Contributing to Braze Docs.

Creating a Jekyll collection

Step 1: Add a new collection

In config.yml, add a new Jekyll collection under the collections key.

1
2
3
4
5
collections:
  COLLECTION_KEY:
    title: COLLECTION_TITLE
    output: true
    default_nav_url: COLLECTION_URL/

Replace the following:

Your new collection should be similar to the following:

1
2
3
4
5
collections:
  partners:
    title: Technology Partners
    output: true
    default_nav_url: home/

Step 2: Set a default layout

In config.yml, set the default layout for your collection under the defaults key.

1
2
3
4
5
6
-  
  scope:
    path: ""
    type: "COLLECTION_KEY"
  values:
    nav_level: 1

Replace COLLECTION_KEY with the key you set up previously. For example:

1
2
3
4
5
6
7
defaults:
  -
    scope:
      path: ""
      type: "partners"
    values:
      nav_level: 1

Step 3: Create a landing page

In the _docs directory, create a new directory and add a new Markdown file named home.md.

1
2
3
4
braze-docs
└── _docs
    └── _COLLECTION_NAME
        └── home.md

Replace _COLLECTION_NAME with the name of your collection using lowercase letters and replacing spaces with underscores. For example:

1
2
3
4
braze-docs
└── _docs
    └── _technology_partners
        └── home.md

Step 4: Add additional content (optional)

Add additional sections and subsections for your new collection. For a full walkthrough, see Creating a section.

1
2
3
4
5
6
braze-docs
└── _docs
    └── PRIMARY_SECTION
        └── SUBSECTION
            ├── NEW_DIRECTORY
            └── NEW_FILE.md

Step 5: Set up a redirect file

In braze-docs/_docs/_docs_pages, create a new Markdown file for your collection.

1
COLLECTION_KEY.md

Replace COLLECTION_KEY with the key you set up previously. For example:

1
2
3
4
braze-docs
└── _docs
    └── _docs_pages
        └── partners.md

In your Markdown file, add the following YAML front matter:

1
2
3
4
5
6
7
---
config_only: true
noindex: true
layout: redirect
redirect_to: /docs/COLLECTION_KEY/home
permalink: COLLECTION_KEY/
---

Replace COLLECTION_KEY with the key you set up previously. For example:

1
2
3
4
5
6
7
---
config_only: true
noindex: true
layout: redirect
redirect_to: /docs/partners/home
permalink: partners/
---