dragonwocky/notion-enhancer
1
0
Fork 0
mirror of https://github.com/notion-enhancer/notion-enhancer.git synced 2025-04-05 13:19:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

i did not know markdown did that

Browse Source
This commit is contained in:
dragonwocky 2020-07-14 21:37:40 +10:00
parent 382af7117c
commit 2237df4334
Signed by: dragonwocky
GPG Key ID: C7A48B7846AA706D
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
DOCUMENTATION.md
View File

@ -28,16 +28,16 @@ each directory in the `mods` folder is considered a module, and consist of 5 fil
`module.exports =` `module.exports =`
| key | value | type | | key | value | type |
| --------- | ----------------------------------------------------------------------------------------------- | --------------- | | --------- | ----------------------------------------------------------------------------------------------- | ----------------- |
| id | **required:** uuidv4 | _string_ | | id | **required:** uuidv4 | _string_ |
| type | **required:** 'extension' or 'theme' | _string_ | | type | **required:** 'extension' or 'theme' | _string_ |
| name | **required:** short name (e.g. 'frameless window') | _string_ | | name | **required:** short name (e.g. 'frameless window') | _string_ |
| desc | **optional:** 1-3 sentence description of what the module is/does | _string_ | | desc | **optional:** 1-3 sentence description of what the module is/does | _string_ |
| version | **required:** semver (e.g. '0.3.7') | _string_ | | version | **required:** semver (e.g. '0.3.7') | _string_ |
| author | **required:** github username | _string_ | | author | **required:** github username | _string_ |
| thumbnail | **optional:** image: relative file or url | _string_ | | thumbnail | **optional:** image: relative file or url | _string_ |
| options | **optional:** see below: options made available in the enhancer menu (accessible from the tray) | _array<object>_ | | options | **optional:** see below: options made available in the enhancer menu (accessible from the tray) | _array\<object\>_ |
`module.exports.options =` `module.exports.options =`