You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 16, 2020. It is now read-only.
Copy file name to clipboardExpand all lines: pages/docs/package-manifest.md
+34-34Lines changed: 34 additions & 34 deletions
Original file line number
Diff line number
Diff line change
@@ -16,25 +16,25 @@ The files must be actual JSON, not just a JavaScript object literal.
16
16
17
17
### Required Fields
18
18
19
-
* <ahref="#field-name">name</a>
20
-
* <ahref="#field-version">version</a>
21
-
* <ahref="#field-title">title</a>
22
-
* <ahref="#field-author">author</a>
23
-
* <ahref="#field-licenses">licenses</a>
24
-
* <ahref="#field-dependencies">dependencies</a>
19
+
* <ahref="#name">name</a>
20
+
* <ahref="#version">version</a>
21
+
* <ahref="#title">title</a>
22
+
* <ahref="#author">author</a>
23
+
* <ahref="#licenses">licenses</a>
24
+
* <ahref="#dependencies">dependencies</a>
25
25
26
26
### Optional Fields
27
27
28
-
* <ahref="#field-description">description</a>
29
-
* <ahref="#field-keywords">keywords</a>
30
-
* <ahref="#field-homepage">homepage</a>
31
-
* <ahref="#field-docs">docs</a>
32
-
* <ahref="#field-demo">demo</a>
33
-
* <ahref="#field-download">download</a>
34
-
* <ahref="#field-bugs">bugs</a>
35
-
* <ahref="#field-maintainers">maintainers</a>
28
+
* <ahref="#description">description</a>
29
+
* <ahref="#keywords">keywords</a>
30
+
* <ahref="#homepage">homepage</a>
31
+
* <ahref="#docs">docs</a>
32
+
* <ahref="#demo">demo</a>
33
+
* <ahref="#download">download</a>
34
+
* <ahref="#bugs">bugs</a>
35
+
* <ahref="#maintainers">maintainers</a>
36
36
37
-
### <aname="field-name">name</a>
37
+
### name
38
38
39
39
The *most* important things in your manifest file are the name and version fields.
40
40
The name and version together form an identifier that is assumed
@@ -54,7 +54,7 @@ to see if there's something by that name already, before you get too attached to
54
54
Site, either consider renaming your plugin or namespacing it. For example, jQuery UI
55
55
plugins are listed with the "ui." prefix (e.g. ui.dialog, ui.autocomplete).
56
56
57
-
### <aname="field-version">version</a>
57
+
### version
58
58
59
59
The *most* important things in your manifest file are the name and version fields.
60
60
The name and version together form an identifier that is assumed
@@ -64,19 +64,19 @@ per [node-semver](https://github.com/isaacs/node-semver).
64
64
65
65
See [Specifying Versions](#specifying-versions).
66
66
67
-
### <aname="field-title">title</a>
67
+
### title
68
68
69
69
A nice complete and pretty title of your plugin. This will be used for the page
70
70
title and top-level heading on your plugin's page. Include jQuery (if you want) and
71
-
spaces and mixed case, unlike [name](#field-name).
71
+
spaces and mixed case, unlike [name](#name).
72
72
73
-
### <aname="field-author">author</a>
73
+
### author
74
74
75
75
One person.
76
76
77
77
See [People Fields](#people-fields).
78
78
79
-
### <aname="field-licenses">licenses</a>
79
+
### licenses
80
80
81
81
Array of licenses under which the plugin is provided. Each license is a hash with
82
82
a url property linking to the actual text and an optional "type" property specifying the type of license. If the license is one of the [official open source licenses](http://www.opensource.org/licenses/alphabetical), the official license name or its abbreviation may be explicated with the "type" property.
@@ -90,7 +90,7 @@ a url property linking to the actual text and an optional "type" property specif
90
90
]
91
91
```
92
92
93
-
### <aname="field-dependencies">dependencies</a>
93
+
### dependencies
94
94
95
95
Dependencies are specified with a simple hash of package name to version
96
96
range. The version range is EITHER a string which has one or more
@@ -106,46 +106,46 @@ of each library you depend on.
106
106
107
107
You must list at least one dependency, `jquery` (note that it's lower-case).
108
108
109
-
### <aname="field-description">description</a>
109
+
### description
110
110
111
111
Put a description in it. It's a string. This helps people discover your
112
112
plugin, as it's listed on the jQuery Plugins Site.
113
113
114
-
### <aname="field-keywords">keywords</a>
114
+
### keywords
115
115
116
116
Put keywords in it. It's an array of strings. This helps people
117
117
discover your plugin as it's listed on the jQuery Plugins Site.
118
118
Keywords may only contain letters, numbers, hyphens, and dots.
119
119
120
-
### <aname="field-homepage">homepage</a>
120
+
### homepage
121
121
122
122
The url to the plugin homepage.
123
123
124
-
### <aname="field-docs">docs</a>
124
+
### docs
125
125
126
126
The url to the plugin documentation.
127
127
128
-
### <aname="field-demo">demo</a>
128
+
### demo
129
129
130
130
The url to the plugin demo or demos.
131
131
132
-
### <aname="field-download">download</a>
132
+
### download
133
133
134
134
The url to download the plugin. A download URL will be automatically generated
135
135
based on the tag in GitHub, but you can specify a custom URL if you'd prefer
136
136
to send users to your own site.
137
137
138
-
### <aname="field-bugs">bugs</a>
138
+
### bugs
139
139
140
140
The url to the bug tracker for the plugin.
141
141
142
-
### <aname="field-maintainers">maintainers</a>
142
+
### maintainers
143
143
144
144
An array of people.
145
145
146
146
See [People Fields](#people-fields).
147
147
148
-
## <aname="people-fields">People Fields</a>
148
+
## People Fields
149
149
150
150
A "person" is an object with a "name" field and optionally "url" and
151
151
"email", like this:
@@ -162,7 +162,7 @@ Both the email and url are optional.
0 commit comments