Created Plugin and Theme METAs (markdown)

Qwerasd 2018-08-27 20:37:22 -04:00
parent 4a538bcc6b
commit ae88006894
1 changed files with 47 additions and 0 deletions

47
Plugin-and-Theme-METAs.md Normal file

@ -0,0 +1,47 @@
# Overview
Theme and plugin METAs are used to provide info about a theme or plugin to BandagedBD.
In order to be recognized theme and plugin files must have a META on the first line.
# Format
The basic format of a META is as such:
```js
//META{"name":"Theme or Plugin Name"}*//
```
# Fields
## Plugins
The following fields can be defined in a META:
|Name|Description|
|-|:-|
|`name`|The name of the theme or plugin.|
|`website`|A website URL leading to a website pertaining to the theme or plugin (e.g. The website of the author).|
|`source`|A URL leading to the source of the theme or plugin (on GitHub or hosted elsewhere).|
A fully formed META for plugins would look like the following:
```js
//META{"name":"Plugin Name","website":"https://example.com/","source":"https://example.com/plugin.js"}*//
```
## Themes
Additionally to those that can be defined for plugins the following fields can be defined in a theme META:
|Name|Description|
|-|:-|
|`description`|A description of the theme.|
|`author`|The author of the theme.|
|`version`|The version of the theme.|
A fully formed META for themes would look like the following:
```js
//META{"name":"Theme Name","website":"https://example.com","source":"https://example.com/theme.css","author":"me","version":"0.0.6","description":"This theme makes things look better."}*//
```