# Config.yml file

{% hint style="info" %}
Please ignore the other configurations set in this file that are not mentioned below. They are included by the Isomer team for your site to work properly.
{% endhint %}

#### Required configuration fields

| Field           | What it means                                                                                                                                                                                             |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| title           | the name of your site. It can be the name of your agency, name of the microsite, etc                                                                                                                      |
| url             | the production URL of your site, e.g. `https://www.abc.gov.sg`. This option is needed for features such as Facebook sharing to work and this will also affect your SEO score on WOGAA or Lighthaus Audit. |
| collections     | a list of all collections on your site. Refer to the [collection configuration](https://v2.isomer.gov.sg/configurations/pages/second-and-third-level-navigation-pages) for more details                   |
| resources\_name | the name of your resource room. Refer to the [resource room setup](https://v2.isomer.gov.sg/configurations/resources) for more details                                                                    |
| favicon         | the file path to the favicon that will appear on the browser window. This file must be in the `.ico` file format and it is usually in your /images folder                                                 |

#### **Optional Fields**

| **Field**         | What it means                                                                                                                                                                                                                                                                                                                                                                                                                            |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| shareicon         | <p>the default preview image displayed on social media platforms such as Facebook and WhatsApp if you share a link to a page on your site. </p><p></p><p><em><strong>Note:</strong> This image option will be overwritten if the page has its own <code>image</code> configuration. If left unspecified, this option defaults to the navigation bar icon. This image should be square, and have a resolution of 600x600 pixels.</em></p> |
| google\_analytics | your Google Analytics tracking ID. [For more information on setting up GA, you can refer to this page.](https://v2.isomer.gov.sg/features/analytics-and-seo/google-analytics)                                                                                                                                                                                                                                                            |
| recommender       | set to `true` to enable the automatic page [recommendation system. ](https://v2.isomer.gov.sg/features/content-recommender)This feature is currently experimental. Defaults to `false`.                                                                                                                                                                                                                                                  |
| is\_government    | set to `false` if you would like to remove the Singapore Government lion masthead at the top of the site. Defaults to `true`.                                                                                                                                                                                                                                                                                                            |
| future            | set to `true` to enable publishing of posts dated in the future. More details can be found in the instructions for [post configuration](https://v2.isomer.gov.sg/configurations/resources/posts).                                                                                                                                                                                                                                        |

Sample configuration (advanced Isomer-specific configuration have been omitted):

```
title: Ministry of ABC
url: "https://www.abc.gov.sg"

collections:
  about-us:
    output: true
  initiatives:
    output: true

resources_name: "media"
favicon: /images/favicon.ico
shareicon: /images/shareicon.png
google_analytics: UA-139339685-1
```