From ebc0414514512239957a15c690c7e6c3c03b22a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20=C4=8Curda?= Date: Wed, 30 Oct 2024 13:37:19 +0100 Subject: [PATCH] Docs(exporter-tokens): Document Themes naming rules #DS-1497 --- exporters/tokens/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/exporters/tokens/README.md b/exporters/tokens/README.md index 9c9ef19e2d..55244b39cd 100644 --- a/exporters/tokens/README.md +++ b/exporters/tokens/README.md @@ -48,5 +48,16 @@ Once activated, the original data will be generated alongside other outputs and - \_original-tokens.json - \_original-groups.json +## Naming Rules for Themes + +For the proper functionality of themes in the Spirit Tokens Exporter in Supernova, all theme names must adhere to specific conventions. +Themes names are imported to Supernova from Figma, and designers are responsible for following these naming rules to ensure the correct +export of design tokens. + +- Spaces are not allowed in theme names, as they disrupt the structure of the generated CSS (SCSS), which relies on precise syntax. +- We recommend using a kebab-case naming format such as `theme-light-default` to ensure consistency and compatibility. + +Adhering to these guidelines helps maintain the integrity of the exported files, ensuring they operate smoothly and without errors. + [supernova-studio]: https://github.com/Supernova-Studio [alma-career]: https://github.com/lmc-eu