forestry-help-menus.md

sitemap
exclude yes

Front matter and menus

In Forestry, the front matter of the articles determine their place in the menu. That means you can manipulate an article's location in the menu system by editing their front matter.

In the Front matter of Forestry, you can create new front matter templates. Create a menu front matter template this way:

1. Click Add template in the top right corner.
2. Add a template name (for example, new-menu-item)
3. Add a Field Group on the right. When its settings appear, enter menu as the label. The same will be entered automatically as the name.
4. In the green box on the left, click the > sign.
5. On the right, select Field Group again.
6. Enter new-menu-item as the label. The same will be entered automatically as the name.
7. In the green box on the left, click the > sign.
8. On the right, select Text field.
9. Enter weight as the label. The same will be entered automatically as the name.
10. Click Create template.

That's it, you are done! Alternatively, you can go to any article that has front matter applied to it, click ... then click Create template - Forestry will create the same template, you just need to change the relevant labels AND names - the names won't be automatically updated with the labels in this case!

Creating a new menu item

Creating a new menu item in Forestry is slightly complicated. Unfortunately, we have to directly edit a .yml files in the GitHub repository.

1. Go to https://github.com/bitrise-io/devcenter/.

2. Enter the data folder and open and edit menus.yml.

3. Under main, enter the title of your new menu item, its identifier and weight.

   Example:

   main:
   - title: New menu item
     identifier: new-menu-item
     weight: 14
   

   The weight specifies the menu item's position relative to the other menu items - enter any value you want, later you can easily change this in Forestry.

4. Add an article that has a front matter menu entry corresponding to the identifier of the menu item. It can be an empty dummy article. You can do this in Forestry by creating a new front matter template and applying that to a dummy article (see Using a front matter template) or in GitHub, manually.

   Example:

   title: Dummy article
   menu:
     new-menu-item:
   	weight: 1
   

5. Go to Forestry and you should see your new menu item in the Menus section.

Adding an article to an existing menu

Once you have an article ready, you want to place it in the menu system so that it is visible on DevCenter. The article has to be in one of the directories on the sidebar!

There are two options:

• adding the article to a menu in the Menus section (recommended in most cases)
• giving the article a front matter template (recommended if you are creating a new main menu item)

Using the Menus section

1. Enter the Menus section.
2. Click the menu you wish to place the article in (for example, iOS Code Signing).
3. Click Add link.
4. Change it to Internal.
5. From the dropdown menu, select the article.
6. Enter its title as the name of the article.
7. Click Done.
8. Click Save in the top right corner.

Using a front matter template

1. Open the sidebar section where the article is located and click on the article.
2. Click the ... sign on the top right corner.
3. Select Change template.
4. Choose the front matter template of the menu where you wish to place the article (for example, ios-code-signing).