# Themes - Add a description field

**URL:** https://meta.discourse.org/t/themes-add-a-description-field/117038
**Category:** UX
**Created:** [5월 7, 2019, 6:50오전 UTC](https://meta.discourse.org/t/themes-add-a-description-field/117038 "2019-05-07T06:50:58Z")
**Posts on this page:** 7
**Page:** 1

<div class="post-metadata">

### Author: ![Biscuit](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/biscuit/32/94482_2.png) [@Biscuit](https://meta.discourse.org/u/Biscuit)
#### Post date: [5월 7, 2019, 6:50오전 UTC](https://meta.discourse.org/t/themes-add-a-description-field/117038/1 "2019-05-07T06:50:58Z")

</div>

**Recommendation:** Please consider adding a Description field to custom-made themes and components.

**Reason:**  
I created some themes a while back and haven’t looked at them for several months. They are no longer fresh in my mind and I realised it would be useful to have a description or notes field, so I can leave comments about the theme’s functionality and/or status (eg: completeness) for myself and/or others admins to reference.

---

<div class="post-metadata">

### Author: ![codinghorror](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/codinghorror/32/110067_2.png) [@codinghorror](https://meta.discourse.org/u/codinghorror)
#### Post date: [5월 7, 2019, 11:56오전 UTC](https://meta.discourse.org/t/themes-add-a-description-field/117038/2 "2019-05-07T11:56:51Z")

</div>

Don’t we have some sort of metadata versioning / comments area in theming @david?

---

<div class="post-metadata">

### Author: ![david](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/david/32/157490_2.png) [@david](https://meta.discourse.org/u/david)
#### Post date: [5월 7, 2019, 12:03오후 UTC](https://meta.discourse.org/t/themes-add-a-description-field/117038/3 "2019-05-07T12:03:35Z")

</div>

Yes, you can add a localisable description to a theme by adding this under `/locales/en.yml`

```plaintext
en:
  theme_metadata:
    description: This is a description for my theme

```

I need to create a #howto for this, thanks for the reminder @Biscuit

---

<div class="post-metadata">

### Author: ![Biscuit](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/biscuit/32/94482_2.png) [@Biscuit](https://meta.discourse.org/u/Biscuit)
#### Post date: [5월 7, 2019, 12:15오후 UTC](https://meta.discourse.org/t/themes-add-a-description-field/117038/5 "2019-05-07T12:15:59Z")

</div>

Thanks for the replies Jeff / David.

How about for themes that people are creating through the UI, without creating YML files, on hosted instances of Discourse?

For example, when I click on: ADMIN \> Customize \> Themes, there’s no field to describe the themes I’ve created. I’d like to have the same commenting ability here, that you’ve added for YML files.

---

<div class="post-metadata">

### Author: ![david](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/david/32/157490_2.png) [@david](https://meta.discourse.org/u/david)
#### Post date: [5월 7, 2019, 12:26오후 UTC](https://meta.discourse.org/t/themes-add-a-description-field/117038/6 "2019-05-07T12:26:43Z")

</div>

You can use the [Install the Discourse Theme CLI console app to help you build themes](https://meta.discourse.org/t/discourse-theme-cli-console-app-to-help-you-build-themes/82950) to add YML files on hosted instances of Discourse. Adding a description field to the UI isn’t currently possible, but we might be able to explore it in future.

---

<div class="post-metadata">

### Author: ![david](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/david/32/157490_2.png) [@david](https://meta.discourse.org/u/david)
#### Post date: [5월 31, 2019, 3:35오후 UTC](https://meta.discourse.org/t/themes-add-a-description-field/117038/7 "2019-05-31T15:35:02Z")

</div>

Information about theme metadata is now available in this topic:

> [@Adding metadata and screenshots to a Theme](https://meta.discourse.org/t/adding-metadata-to-a-theme/119205):
>
> You can add various pieces of metadata to a theme. Some are stored in the about.json file, and some are stored in the locale files. about.json [link file format info](https://meta.discourse.org/t/structure-of-themes-and-theme-components/60848) name (string, required): The default name for the theme when installed. This can be changed by admins after the theme is installed. component (boolean, default false): whether the theme should be treated as a component. license\_url (string, optional): a URL for a license file. A link to this will be displayed in the admin interf…

---

<div class="post-metadata">

### Author: ![david](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/david/32/157490_2.png) [@david](https://meta.discourse.org/u/david)
#### Post date: [6월 1, 2019, 5:00오후 UTC](https://meta.discourse.org/t/themes-add-a-description-field/117038/8 "2019-06-01T17:00:03Z")

</div>

This topic was automatically closed after 25 hours. New replies are no longer allowed.
