xodio / xod-docs

XOD Documentation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Make reference/shortcuts use YAML data

nkrkv opened this issue · comments

Currently, the shortcuts reference list items through plain HTML tables.

The items are a highly structured data that might be defined in a YAML file. This way is preferable because if we want to make a slight change in the HTML markup, we are in trouble: changes in every line of the table across all translations will be required.

To support translations the YAML source can have a separate description field for every language:

- shortcut:
    mac: ⌘ N
    pc: Ctrl+N
    action:
      EN: "New patch"
      DE: "Neu patch"
      RU: "Новый патч"