Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jose committed Sep 12, 2023
1 parent f99cec6 commit 141cf5a
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,19 @@ Add a config file on the root directory of your project with the default name
specify a different config file while executing. You can find a template for your config file
[here](template.config.json)


| Field | Description |
| ------------- | ------------- |
| FIGMA_APIKEY | Yep... Figma API key |
| FIGMA_ID | Your user ID, you can find it when sharing something. [More info here](https://iconify.design/docs/libraries/tools/import/figma/file-id.html) |
| FIGMA_PAGE_NAME | The name of the page, be aware of spaces and everything (emojis)... |
| TOKENS_DIR | Where do you want to create the output files in your project. |
| pages | The FRAMES inside the page you want to take the tokens from. |
| source | ... IDK |
| platforms | The "platform" you will use this tokens. |

<!-- TODO: I'd say this is outdated, check [Figma Tokens](https://github.com/klaufel/figma-tokens) -->

### Execution

Then execute:
Expand Down
5 changes: 4 additions & 1 deletion template.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
"FIGMA_ID": "",
"FIGMA_PAGE_NAME": "Design Tokens",
"TOKENS_DIR": "design-tokens",
"source": ["design-tokens/**/*.json"],
"pages": [],
"source": [
"design-tokens/**/*.json"
],
"platforms": {
"scss": {
"transformGroup": "scss",
Expand Down

0 comments on commit 141cf5a

Please sign in to comment.