Skip to content

Commit 71b1f00

Browse files
kraftbjkraftbj
authored
update docs generator for correct manifest (#32)
1 parent afe840b commit 71b1f00

File tree

2 files changed

+39
-34
lines changed

2 files changed

+39
-34
lines changed

‎docs/bin/generate-manifest.php‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,12 @@
5454
$manifest[ $key ] = array(
5555
'slug' => $slug,
5656
'parent' => $parent,
57-
'markdown_source' => sprintf( 'https://github.com/%s/blob/trunk/docs/%s.md', $repo, $key . ( 'index' === basename( $key ) ? '' : '/index' ) ),
57+
'markdown_source' => sprintf(
58+
'https://github.com/%s/blob/trunk/docs/%s%s',
59+
$repo,
60+
$key,
61+
basename( $file ) === 'index.md' ? '/index.md' : '.md'
62+
),
5863
);
5964
}
6065
}

‎docs/bin/manifest.json‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"concepts/architecture": {
33
"slug": "architecture",
44
"parent": "concepts",
5-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/concepts/architecture/index.md"
5+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/concepts/architecture.md"
66
},
77
"concepts": {
88
"slug": "concepts",
@@ -12,12 +12,12 @@
1212
"concepts/security": {
1313
"slug": "security",
1414
"parent": "concepts",
15-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/concepts/security/index.md"
15+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/concepts/security.md"
1616
},
1717
"contributing/documentation": {
1818
"slug": "documentation",
1919
"parent": "contributing",
20-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/contributing/documentation/index.md"
20+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/contributing/documentation.md"
2121
},
2222
"contributing": {
2323
"slug": "contributing",
@@ -27,7 +27,7 @@
2727
"features/api": {
2828
"slug": "api",
2929
"parent": "features",
30-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/api/index.md"
30+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/api.md"
3131
},
3232
"features/fields": {
3333
"slug": "fields",
@@ -42,7 +42,7 @@
4242
"features/post-types": {
4343
"slug": "post-types",
4444
"parent": "features",
45-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/post-types/index.md"
45+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/post-types.md"
4646
},
4747
"getting-started": {
4848
"slug": "getting-started",
@@ -52,17 +52,17 @@
5252
"getting-started/installation": {
5353
"slug": "installation",
5454
"parent": "getting-started",
55-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/getting-started/installation/index.md"
55+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/getting-started/installation.md"
5656
},
5757
"getting-started/quick-start": {
5858
"slug": "quick-start",
5959
"parent": "getting-started",
60-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/getting-started/quick-start/index.md"
60+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/getting-started/quick-start.md"
6161
},
6262
"tutorials/first-post-type": {
6363
"slug": "first-post-type",
6464
"parent": "tutorials",
65-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/tutorials/first-post-type/index.md"
65+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/tutorials/first-post-type.md"
6666
},
6767
"tutorials": {
6868
"slug": "tutorials",
@@ -77,7 +77,7 @@
7777
"features/fields/tutorial": {
7878
"slug": "tutorial",
7979
"parent": "features/fields",
80-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/tutorial/index.md"
80+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/tutorial.md"
8181
},
8282
"features/fields/accordion": {
8383
"slug": "accordion",
@@ -87,7 +87,7 @@
8787
"features/fields/accordion/tutorial": {
8888
"slug": "tutorial",
8989
"parent": "features/fields/accordion",
90-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/accordion/tutorial/index.md"
90+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/accordion/tutorial.md"
9191
},
9292
"features/fields/button-group": {
9393
"slug": "button-group",
@@ -97,7 +97,7 @@
9797
"features/fields/button-group/tutorial": {
9898
"slug": "tutorial",
9999
"parent": "features/fields/button-group",
100-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/button-group/tutorial/index.md"
100+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/button-group/tutorial.md"
101101
},
102102
"features/fields/checkbox": {
103103
"slug": "checkbox",
@@ -107,12 +107,12 @@
107107
"features/fields/checkbox/tutorial": {
108108
"slug": "tutorial",
109109
"parent": "features/fields/checkbox",
110-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/checkbox/tutorial/index.md"
110+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/checkbox/tutorial.md"
111111
},
112112
"features/fields/clone/tutorial": {
113113
"slug": "tutorial",
114114
"parent": "features/fields/clone",
115-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/clone/tutorial/index.md"
115+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/clone/tutorial.md"
116116
},
117117
"features/fields/color-picker": {
118118
"slug": "color-picker",
@@ -122,7 +122,7 @@
122122
"features/fields/color-picker/tutorial": {
123123
"slug": "tutorial",
124124
"parent": "features/fields/color-picker",
125-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/color-picker/tutorial/index.md"
125+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/color-picker/tutorial.md"
126126
},
127127
"features/fields/date-picker": {
128128
"slug": "date-picker",
@@ -132,7 +132,7 @@
132132
"features/fields/date-picker/tutorial": {
133133
"slug": "tutorial",
134134
"parent": "features/fields/date-picker",
135-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/date-picker/tutorial/index.md"
135+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/date-picker/tutorial.md"
136136
},
137137
"features/fields/date-time-picker": {
138138
"slug": "date-time-picker",
@@ -142,7 +142,7 @@
142142
"features/fields/date-time-picker/tutorial": {
143143
"slug": "tutorial",
144144
"parent": "features/fields/date-time-picker",
145-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/date-time-picker/tutorial/index.md"
145+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/date-time-picker/tutorial.md"
146146
},
147147
"features/fields/email": {
148148
"slug": "email",
@@ -152,7 +152,7 @@
152152
"features/fields/email/tutorial": {
153153
"slug": "tutorial",
154154
"parent": "features/fields/email",
155-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/email/tutorial/index.md"
155+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/email/tutorial.md"
156156
},
157157
"features/fields/file": {
158158
"slug": "file",
@@ -162,7 +162,7 @@
162162
"features/fields/file/tutorial": {
163163
"slug": "tutorial",
164164
"parent": "features/fields/file",
165-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/file/tutorial/index.md"
165+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/file/tutorial.md"
166166
},
167167
"features/fields/flexible-content": {
168168
"slug": "flexible-content",
@@ -172,7 +172,7 @@
172172
"features/fields/flexible-content/tutorial": {
173173
"slug": "tutorial",
174174
"parent": "features/fields/flexible-content",
175-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/flexible-content/tutorial/index.md"
175+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/flexible-content/tutorial.md"
176176
},
177177
"features/fields/gallery": {
178178
"slug": "gallery",
@@ -182,7 +182,7 @@
182182
"features/fields/gallery/tutorial": {
183183
"slug": "tutorial",
184184
"parent": "features/fields/gallery",
185-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/gallery/tutorial/index.md"
185+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/gallery/tutorial.md"
186186
},
187187
"features/fields/google-map": {
188188
"slug": "google-map",
@@ -192,7 +192,7 @@
192192
"features/fields/google-map/tutorial": {
193193
"slug": "tutorial",
194194
"parent": "features/fields/google-map",
195-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/google-map/tutorial/index.md"
195+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/google-map/tutorial.md"
196196
},
197197
"features/fields/group": {
198198
"slug": "group",
@@ -202,7 +202,7 @@
202202
"features/fields/group/tutorial": {
203203
"slug": "tutorial",
204204
"parent": "features/fields/group",
205-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/group/tutorial/index.md"
205+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/group/tutorial.md"
206206
},
207207
"features/fields/icon-picker": {
208208
"slug": "icon-picker",
@@ -212,7 +212,7 @@
212212
"features/fields/icon-picker/tutorial": {
213213
"slug": "tutorial",
214214
"parent": "features/fields/icon-picker",
215-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/icon-picker/tutorial/index.md"
215+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/icon-picker/tutorial.md"
216216
},
217217
"features/fields/image": {
218218
"slug": "image",
@@ -222,7 +222,7 @@
222222
"features/fields/image/tutorial": {
223223
"slug": "tutorial",
224224
"parent": "features/fields/image",
225-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/image/tutorial/index.md"
225+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/image/tutorial.md"
226226
},
227227
"features/fields/link": {
228228
"slug": "link",
@@ -232,7 +232,7 @@
232232
"features/fields/link/tutorial": {
233233
"slug": "tutorial",
234234
"parent": "features/fields/link",
235-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/link/tutorial/index.md"
235+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/link/tutorial.md"
236236
},
237237
"features/fields/message": {
238238
"slug": "message",
@@ -242,7 +242,7 @@
242242
"features/fields/message/tutorial": {
243243
"slug": "tutorial",
244244
"parent": "features/fields/message",
245-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/message/tutorial/index.md"
245+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/message/tutorial.md"
246246
},
247247
"features/fields/number": {
248248
"slug": "number",
@@ -252,7 +252,7 @@
252252
"features/fields/number/tutorial": {
253253
"slug": "tutorial",
254254
"parent": "features/fields/number",
255-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/number/tutorial/index.md"
255+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/number/tutorial.md"
256256
},
257257
"features/fields/oembed": {
258258
"slug": "oembed",
@@ -262,7 +262,7 @@
262262
"features/fields/oembed/tutorial": {
263263
"slug": "tutorial",
264264
"parent": "features/fields/oembed",
265-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/oembed/tutorial/index.md"
265+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/oembed/tutorial.md"
266266
},
267267
"features/fields/page-link": {
268268
"slug": "page-link",
@@ -272,7 +272,7 @@
272272
"features/fields/page-link/tutorial": {
273273
"slug": "tutorial",
274274
"parent": "features/fields/page-link",
275-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/page-link/tutorial/index.md"
275+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/page-link/tutorial.md"
276276
},
277277
"features/fields/password": {
278278
"slug": "password",
@@ -282,7 +282,7 @@
282282
"features/fields/password/tutorial": {
283283
"slug": "tutorial",
284284
"parent": "features/fields/password",
285-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/password/tutorial/index.md"
285+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/password/tutorial.md"
286286
},
287287
"features/fields/post-object": {
288288
"slug": "post-object",
@@ -292,7 +292,7 @@
292292
"features/fields/post-object/tutorial": {
293293
"slug": "tutorial",
294294
"parent": "features/fields/post-object",
295-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/post-object/tutorial/index.md"
295+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/post-object/tutorial.md"
296296
},
297297
"features/fields/radio": {
298298
"slug": "radio",
@@ -302,7 +302,7 @@
302302
"features/fields/radio/tutorial": {
303303
"slug": "tutorial",
304304
"parent": "features/fields/radio",
305-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/radio/tutorial/index.md"
305+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/radio/tutorial.md"
306306
},
307307
"features/fields/range": {
308308
"slug": "range",
@@ -312,6 +312,6 @@
312312
"features/fields/range/tutorial": {
313313
"slug": "tutorial",
314314
"parent": "features/fields/range",
315-
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/range/tutorial/index.md"
315+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/range/tutorial.md"
316316
}
317317
}

0 commit comments

Comments
 (0)