readme-guide 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +46 -2
- package/bin/readme-guide.mjs +125 -0
- package/package.json +43 -4
- package/rules/blocks.json +123 -0
- package/rules/conventions.json +39 -0
- package/rules/headings.json +556 -0
- package/rules/project-types.json +37 -0
- package/rules/rules.json +3575 -0
- package/src/checks/ai.js +41 -0
- package/src/checks/commands.js +248 -0
- package/src/checks/env.js +112 -0
- package/src/checks/folders.js +138 -0
- package/src/checks/license.js +137 -0
- package/src/checks/media.js +110 -0
- package/src/checks/structure.js +248 -0
- package/src/checks/types.js +55 -0
- package/src/checks/util.js +148 -0
- package/src/checks/versions.js +109 -0
- package/src/data.js +76 -0
- package/src/detect.js +83 -0
- package/src/explain.js +150 -0
- package/src/format.js +153 -0
- package/src/lint.js +142 -0
- package/src/markdown.js +424 -0
- package/src/project.js +86 -0
- package/src/sections.js +167 -0
- package/src/semver.js +104 -0
|
@@ -0,0 +1,556 @@
|
|
|
1
|
+
{
|
|
2
|
+
"sections": [
|
|
3
|
+
{
|
|
4
|
+
"id": "demo",
|
|
5
|
+
"block": "demo",
|
|
6
|
+
"level": 2,
|
|
7
|
+
"title": {
|
|
8
|
+
"zh-TW": "線上展示",
|
|
9
|
+
"en": "Demo"
|
|
10
|
+
},
|
|
11
|
+
"aliases": {
|
|
12
|
+
"zh-TW": [
|
|
13
|
+
"展示",
|
|
14
|
+
"線上預覽",
|
|
15
|
+
"預覽",
|
|
16
|
+
"線上網址",
|
|
17
|
+
"展示網址"
|
|
18
|
+
],
|
|
19
|
+
"en": [
|
|
20
|
+
"Live Demo",
|
|
21
|
+
"Preview",
|
|
22
|
+
"Live Preview",
|
|
23
|
+
"Live Site",
|
|
24
|
+
"Website"
|
|
25
|
+
]
|
|
26
|
+
}
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"id": "api-docs",
|
|
30
|
+
"block": "demo",
|
|
31
|
+
"level": 2,
|
|
32
|
+
"title": {
|
|
33
|
+
"zh-TW": "API 文件",
|
|
34
|
+
"en": "API Documentation"
|
|
35
|
+
},
|
|
36
|
+
"aliases": {
|
|
37
|
+
"zh-TW": [
|
|
38
|
+
"API 文件在哪",
|
|
39
|
+
"API 說明文件",
|
|
40
|
+
"API 文件位置"
|
|
41
|
+
],
|
|
42
|
+
"en": [
|
|
43
|
+
"API Docs",
|
|
44
|
+
"API Reference",
|
|
45
|
+
"API Documentation"
|
|
46
|
+
]
|
|
47
|
+
}
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"id": "screenshots",
|
|
51
|
+
"block": "demo",
|
|
52
|
+
"level": 2,
|
|
53
|
+
"title": {
|
|
54
|
+
"zh-TW": "畫面",
|
|
55
|
+
"en": "Screenshots"
|
|
56
|
+
},
|
|
57
|
+
"aliases": {
|
|
58
|
+
"zh-TW": [
|
|
59
|
+
"截圖",
|
|
60
|
+
"畫面截圖",
|
|
61
|
+
"專案截圖",
|
|
62
|
+
"預覽圖",
|
|
63
|
+
"專案畫面"
|
|
64
|
+
],
|
|
65
|
+
"en": [
|
|
66
|
+
"Screenshot",
|
|
67
|
+
"Screens"
|
|
68
|
+
]
|
|
69
|
+
}
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
"id": "learning-objectives",
|
|
73
|
+
"block": "features",
|
|
74
|
+
"level": 2,
|
|
75
|
+
"title": {
|
|
76
|
+
"zh-TW": "學習目標",
|
|
77
|
+
"en": "Learning Objectives"
|
|
78
|
+
},
|
|
79
|
+
"aliases": {
|
|
80
|
+
"zh-TW": [
|
|
81
|
+
"你會學到",
|
|
82
|
+
"你會學到什麼",
|
|
83
|
+
"學習重點",
|
|
84
|
+
"課程目標"
|
|
85
|
+
],
|
|
86
|
+
"en": [
|
|
87
|
+
"What You Will Learn",
|
|
88
|
+
"What You'll Learn",
|
|
89
|
+
"Learning Goals",
|
|
90
|
+
"Objectives"
|
|
91
|
+
]
|
|
92
|
+
}
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
"id": "course-unit",
|
|
96
|
+
"block": "features",
|
|
97
|
+
"level": 2,
|
|
98
|
+
"title": {
|
|
99
|
+
"zh-TW": "對應單元",
|
|
100
|
+
"en": "Course Unit"
|
|
101
|
+
},
|
|
102
|
+
"aliases": {
|
|
103
|
+
"zh-TW": [
|
|
104
|
+
"對應課程",
|
|
105
|
+
"課程單元",
|
|
106
|
+
"課程資訊",
|
|
107
|
+
"對應章節"
|
|
108
|
+
],
|
|
109
|
+
"en": [
|
|
110
|
+
"Lesson",
|
|
111
|
+
"Course",
|
|
112
|
+
"Course Info",
|
|
113
|
+
"Module",
|
|
114
|
+
"Chapter"
|
|
115
|
+
]
|
|
116
|
+
}
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
"id": "features",
|
|
120
|
+
"block": "features",
|
|
121
|
+
"level": 2,
|
|
122
|
+
"title": {
|
|
123
|
+
"zh-TW": "功能",
|
|
124
|
+
"en": "Features"
|
|
125
|
+
},
|
|
126
|
+
"aliases": {
|
|
127
|
+
"zh-TW": [
|
|
128
|
+
"功能介紹",
|
|
129
|
+
"功能列表",
|
|
130
|
+
"主要功能",
|
|
131
|
+
"特色",
|
|
132
|
+
"API 一覽",
|
|
133
|
+
"API 列表"
|
|
134
|
+
],
|
|
135
|
+
"en": [
|
|
136
|
+
"Feature List",
|
|
137
|
+
"Key Features",
|
|
138
|
+
"Endpoints",
|
|
139
|
+
"API Endpoints",
|
|
140
|
+
"API Overview"
|
|
141
|
+
]
|
|
142
|
+
}
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
"id": "my-role",
|
|
146
|
+
"block": "features",
|
|
147
|
+
"level": 2,
|
|
148
|
+
"title": {
|
|
149
|
+
"zh-TW": "我負責的部分",
|
|
150
|
+
"en": "My Role"
|
|
151
|
+
},
|
|
152
|
+
"aliases": {
|
|
153
|
+
"zh-TW": [
|
|
154
|
+
"我的角色",
|
|
155
|
+
"負責項目",
|
|
156
|
+
"我做了什麼",
|
|
157
|
+
"個人貢獻",
|
|
158
|
+
"我的貢獻"
|
|
159
|
+
],
|
|
160
|
+
"en": [
|
|
161
|
+
"Responsibilities",
|
|
162
|
+
"My Contributions",
|
|
163
|
+
"What I Did",
|
|
164
|
+
"My Part"
|
|
165
|
+
]
|
|
166
|
+
}
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
"id": "tech",
|
|
170
|
+
"block": "tech",
|
|
171
|
+
"level": 2,
|
|
172
|
+
"title": {
|
|
173
|
+
"zh-TW": "使用技術",
|
|
174
|
+
"en": "Tech Stack"
|
|
175
|
+
},
|
|
176
|
+
"aliases": {
|
|
177
|
+
"zh-TW": [
|
|
178
|
+
"技術",
|
|
179
|
+
"專案技術",
|
|
180
|
+
"技術棧",
|
|
181
|
+
"使用的技術",
|
|
182
|
+
"技術選型",
|
|
183
|
+
"開發技術"
|
|
184
|
+
],
|
|
185
|
+
"en": [
|
|
186
|
+
"Built With",
|
|
187
|
+
"Technologies",
|
|
188
|
+
"Technology",
|
|
189
|
+
"Tech",
|
|
190
|
+
"Stack",
|
|
191
|
+
"Technologies Used"
|
|
192
|
+
]
|
|
193
|
+
}
|
|
194
|
+
},
|
|
195
|
+
{
|
|
196
|
+
"id": "design-decisions",
|
|
197
|
+
"block": "tech",
|
|
198
|
+
"level": 2,
|
|
199
|
+
"title": {
|
|
200
|
+
"zh-TW": "為什麼這樣做",
|
|
201
|
+
"en": "Design Decisions"
|
|
202
|
+
},
|
|
203
|
+
"aliases": {
|
|
204
|
+
"zh-TW": [
|
|
205
|
+
"技術決策",
|
|
206
|
+
"設計決策",
|
|
207
|
+
"技術選擇",
|
|
208
|
+
"為什麼選這些技術"
|
|
209
|
+
],
|
|
210
|
+
"en": [
|
|
211
|
+
"Technical Decisions",
|
|
212
|
+
"Why This Stack",
|
|
213
|
+
"Decisions",
|
|
214
|
+
"Why"
|
|
215
|
+
]
|
|
216
|
+
}
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"id": "getting-started",
|
|
220
|
+
"block": "install",
|
|
221
|
+
"level": 2,
|
|
222
|
+
"title": {
|
|
223
|
+
"zh-TW": "安裝與執行",
|
|
224
|
+
"en": "Getting Started"
|
|
225
|
+
},
|
|
226
|
+
"aliases": {
|
|
227
|
+
"zh-TW": [
|
|
228
|
+
"安裝",
|
|
229
|
+
"安裝說明",
|
|
230
|
+
"快速開始",
|
|
231
|
+
"開始使用",
|
|
232
|
+
"如何執行",
|
|
233
|
+
"本機執行",
|
|
234
|
+
"執行方式"
|
|
235
|
+
],
|
|
236
|
+
"en": [
|
|
237
|
+
"Installation",
|
|
238
|
+
"Install",
|
|
239
|
+
"Setup",
|
|
240
|
+
"Quick Start",
|
|
241
|
+
"Quickstart",
|
|
242
|
+
"How to Run",
|
|
243
|
+
"Running Locally",
|
|
244
|
+
"Local Development"
|
|
245
|
+
]
|
|
246
|
+
}
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
"id": "requirements",
|
|
250
|
+
"block": "install",
|
|
251
|
+
"level": 3,
|
|
252
|
+
"title": {
|
|
253
|
+
"zh-TW": "環境需求",
|
|
254
|
+
"en": "Requirements"
|
|
255
|
+
},
|
|
256
|
+
"aliases": {
|
|
257
|
+
"zh-TW": [
|
|
258
|
+
"前置需求",
|
|
259
|
+
"系統需求",
|
|
260
|
+
"事前準備",
|
|
261
|
+
"開發環境"
|
|
262
|
+
],
|
|
263
|
+
"en": [
|
|
264
|
+
"Prerequisites",
|
|
265
|
+
"Dependencies",
|
|
266
|
+
"System Requirements"
|
|
267
|
+
]
|
|
268
|
+
}
|
|
269
|
+
},
|
|
270
|
+
{
|
|
271
|
+
"id": "install-steps",
|
|
272
|
+
"block": "install",
|
|
273
|
+
"level": 3,
|
|
274
|
+
"title": {
|
|
275
|
+
"zh-TW": "安裝步驟",
|
|
276
|
+
"en": "Installation"
|
|
277
|
+
},
|
|
278
|
+
"aliases": {
|
|
279
|
+
"zh-TW": [
|
|
280
|
+
"安裝",
|
|
281
|
+
"步驟"
|
|
282
|
+
],
|
|
283
|
+
"en": [
|
|
284
|
+
"Install",
|
|
285
|
+
"Installing",
|
|
286
|
+
"Setup",
|
|
287
|
+
"Steps"
|
|
288
|
+
]
|
|
289
|
+
}
|
|
290
|
+
},
|
|
291
|
+
{
|
|
292
|
+
"id": "testing",
|
|
293
|
+
"block": "install",
|
|
294
|
+
"level": 3,
|
|
295
|
+
"title": {
|
|
296
|
+
"zh-TW": "執行測試",
|
|
297
|
+
"en": "Running Tests"
|
|
298
|
+
},
|
|
299
|
+
"aliases": {
|
|
300
|
+
"zh-TW": [
|
|
301
|
+
"測試"
|
|
302
|
+
],
|
|
303
|
+
"en": [
|
|
304
|
+
"Tests",
|
|
305
|
+
"Testing",
|
|
306
|
+
"Run Tests"
|
|
307
|
+
]
|
|
308
|
+
}
|
|
309
|
+
},
|
|
310
|
+
{
|
|
311
|
+
"id": "database",
|
|
312
|
+
"block": "install",
|
|
313
|
+
"level": 2,
|
|
314
|
+
"title": {
|
|
315
|
+
"zh-TW": "建立資料庫",
|
|
316
|
+
"en": "Database Setup"
|
|
317
|
+
},
|
|
318
|
+
"aliases": {
|
|
319
|
+
"zh-TW": [
|
|
320
|
+
"資料庫",
|
|
321
|
+
"資料庫設定",
|
|
322
|
+
"資料庫建立",
|
|
323
|
+
"資料庫初始化"
|
|
324
|
+
],
|
|
325
|
+
"en": [
|
|
326
|
+
"Database",
|
|
327
|
+
"Migrations",
|
|
328
|
+
"Seeding"
|
|
329
|
+
]
|
|
330
|
+
}
|
|
331
|
+
},
|
|
332
|
+
{
|
|
333
|
+
"id": "start-finish",
|
|
334
|
+
"block": "install",
|
|
335
|
+
"level": 2,
|
|
336
|
+
"title": {
|
|
337
|
+
"zh-TW": "起始版與完成版",
|
|
338
|
+
"en": "Starter and Solution"
|
|
339
|
+
},
|
|
340
|
+
"aliases": {
|
|
341
|
+
"zh-TW": [
|
|
342
|
+
"起始版本與完成版本",
|
|
343
|
+
"起始檔與完成檔",
|
|
344
|
+
"練習版與解答",
|
|
345
|
+
"分支說明"
|
|
346
|
+
],
|
|
347
|
+
"en": [
|
|
348
|
+
"Starter and Final",
|
|
349
|
+
"Starter & Solution",
|
|
350
|
+
"Start and Finish",
|
|
351
|
+
"Branches"
|
|
352
|
+
]
|
|
353
|
+
}
|
|
354
|
+
},
|
|
355
|
+
{
|
|
356
|
+
"id": "usage",
|
|
357
|
+
"block": "install",
|
|
358
|
+
"level": 2,
|
|
359
|
+
"title": {
|
|
360
|
+
"zh-TW": "使用方式",
|
|
361
|
+
"en": "Usage"
|
|
362
|
+
},
|
|
363
|
+
"aliases": {
|
|
364
|
+
"zh-TW": [
|
|
365
|
+
"使用說明",
|
|
366
|
+
"操作方式",
|
|
367
|
+
"如何使用",
|
|
368
|
+
"使用範例",
|
|
369
|
+
"API 範例",
|
|
370
|
+
"請求範例"
|
|
371
|
+
],
|
|
372
|
+
"en": [
|
|
373
|
+
"Examples",
|
|
374
|
+
"Example",
|
|
375
|
+
"How to Use",
|
|
376
|
+
"Request Examples"
|
|
377
|
+
]
|
|
378
|
+
}
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
"id": "env",
|
|
382
|
+
"block": "env",
|
|
383
|
+
"level": 2,
|
|
384
|
+
"title": {
|
|
385
|
+
"zh-TW": "環境變數",
|
|
386
|
+
"en": "Environment Variables"
|
|
387
|
+
},
|
|
388
|
+
"aliases": {
|
|
389
|
+
"zh-TW": [
|
|
390
|
+
"環境變數說明",
|
|
391
|
+
"環境變數設定",
|
|
392
|
+
"環境設定",
|
|
393
|
+
"設定"
|
|
394
|
+
],
|
|
395
|
+
"en": [
|
|
396
|
+
"Configuration",
|
|
397
|
+
"Config",
|
|
398
|
+
"Env",
|
|
399
|
+
".env",
|
|
400
|
+
"Environment"
|
|
401
|
+
]
|
|
402
|
+
}
|
|
403
|
+
},
|
|
404
|
+
{
|
|
405
|
+
"id": "structure",
|
|
406
|
+
"block": "structure",
|
|
407
|
+
"level": 2,
|
|
408
|
+
"title": {
|
|
409
|
+
"zh-TW": "資料夾結構",
|
|
410
|
+
"en": "Project Structure"
|
|
411
|
+
},
|
|
412
|
+
"aliases": {
|
|
413
|
+
"zh-TW": [
|
|
414
|
+
"資料夾說明",
|
|
415
|
+
"目錄結構",
|
|
416
|
+
"專案結構",
|
|
417
|
+
"檔案結構",
|
|
418
|
+
"資料夾架構"
|
|
419
|
+
],
|
|
420
|
+
"en": [
|
|
421
|
+
"Folder Structure",
|
|
422
|
+
"Directory Structure",
|
|
423
|
+
"File Structure",
|
|
424
|
+
"Project Layout"
|
|
425
|
+
]
|
|
426
|
+
}
|
|
427
|
+
},
|
|
428
|
+
{
|
|
429
|
+
"id": "contributing",
|
|
430
|
+
"block": "license",
|
|
431
|
+
"level": 2,
|
|
432
|
+
"title": {
|
|
433
|
+
"zh-TW": "貢獻方式",
|
|
434
|
+
"en": "Contributing"
|
|
435
|
+
},
|
|
436
|
+
"aliases": {
|
|
437
|
+
"zh-TW": [
|
|
438
|
+
"如何貢獻",
|
|
439
|
+
"參與貢獻"
|
|
440
|
+
],
|
|
441
|
+
"en": [
|
|
442
|
+
"Contribution",
|
|
443
|
+
"Contributions",
|
|
444
|
+
"How to Contribute"
|
|
445
|
+
]
|
|
446
|
+
}
|
|
447
|
+
},
|
|
448
|
+
{
|
|
449
|
+
"id": "author",
|
|
450
|
+
"block": "license",
|
|
451
|
+
"level": 2,
|
|
452
|
+
"title": {
|
|
453
|
+
"zh-TW": "作者與聯絡",
|
|
454
|
+
"en": "Author"
|
|
455
|
+
},
|
|
456
|
+
"aliases": {
|
|
457
|
+
"zh-TW": [
|
|
458
|
+
"聯絡作者",
|
|
459
|
+
"聯絡方式",
|
|
460
|
+
"作者",
|
|
461
|
+
"聯絡",
|
|
462
|
+
"關於作者",
|
|
463
|
+
"作者資訊",
|
|
464
|
+
"團隊成員",
|
|
465
|
+
"維護團隊",
|
|
466
|
+
"維護者",
|
|
467
|
+
"維護人員",
|
|
468
|
+
"負責團隊",
|
|
469
|
+
"負責單位",
|
|
470
|
+
"負責人",
|
|
471
|
+
"聯絡窗口",
|
|
472
|
+
"窗口",
|
|
473
|
+
"聯絡我們",
|
|
474
|
+
"有問題找誰"
|
|
475
|
+
],
|
|
476
|
+
"en": [
|
|
477
|
+
"Contact",
|
|
478
|
+
"Author / Contact",
|
|
479
|
+
"Authors",
|
|
480
|
+
"Maintainers",
|
|
481
|
+
"Maintainer",
|
|
482
|
+
"About the Author",
|
|
483
|
+
"Team",
|
|
484
|
+
"Owner",
|
|
485
|
+
"Owners",
|
|
486
|
+
"Ownership",
|
|
487
|
+
"Contact Us",
|
|
488
|
+
"Support",
|
|
489
|
+
"Maintained By",
|
|
490
|
+
"Point of Contact"
|
|
491
|
+
]
|
|
492
|
+
}
|
|
493
|
+
},
|
|
494
|
+
{
|
|
495
|
+
"id": "acknowledgments",
|
|
496
|
+
"block": "license",
|
|
497
|
+
"level": 2,
|
|
498
|
+
"title": {
|
|
499
|
+
"zh-TW": "致謝",
|
|
500
|
+
"en": "Acknowledgments"
|
|
501
|
+
},
|
|
502
|
+
"aliases": {
|
|
503
|
+
"zh-TW": [
|
|
504
|
+
"感謝",
|
|
505
|
+
"特別感謝"
|
|
506
|
+
],
|
|
507
|
+
"en": [
|
|
508
|
+
"Acknowledgements",
|
|
509
|
+
"Credits",
|
|
510
|
+
"Thanks"
|
|
511
|
+
]
|
|
512
|
+
}
|
|
513
|
+
},
|
|
514
|
+
{
|
|
515
|
+
"id": "license",
|
|
516
|
+
"block": "license",
|
|
517
|
+
"level": 2,
|
|
518
|
+
"title": {
|
|
519
|
+
"zh-TW": "授權",
|
|
520
|
+
"en": "License"
|
|
521
|
+
},
|
|
522
|
+
"aliases": {
|
|
523
|
+
"zh-TW": [
|
|
524
|
+
"授權條款",
|
|
525
|
+
"授權方式",
|
|
526
|
+
"版權",
|
|
527
|
+
"版權聲明"
|
|
528
|
+
],
|
|
529
|
+
"en": [
|
|
530
|
+
"Licence",
|
|
531
|
+
"Licensing",
|
|
532
|
+
"Copyright"
|
|
533
|
+
]
|
|
534
|
+
}
|
|
535
|
+
}
|
|
536
|
+
],
|
|
537
|
+
"combined": [
|
|
538
|
+
{
|
|
539
|
+
"sections": [
|
|
540
|
+
"demo",
|
|
541
|
+
"screenshots"
|
|
542
|
+
],
|
|
543
|
+
"aliases": {
|
|
544
|
+
"zh-TW": [
|
|
545
|
+
"線上展示與畫面",
|
|
546
|
+
"展示與畫面",
|
|
547
|
+
"線上展示與截圖"
|
|
548
|
+
],
|
|
549
|
+
"en": [
|
|
550
|
+
"Demo and Screenshots",
|
|
551
|
+
"Demo & Screenshots"
|
|
552
|
+
]
|
|
553
|
+
}
|
|
554
|
+
}
|
|
555
|
+
]
|
|
556
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
{
|
|
2
|
+
"default": "web-app",
|
|
3
|
+
"types": [
|
|
4
|
+
{
|
|
5
|
+
"id": "web-app",
|
|
6
|
+
"name": { "zh-TW": "網頁專案", "en": "Web app" },
|
|
7
|
+
"description": { "zh-TW": "打開瀏覽器就能用的網站或網頁應用程式。", "en": "A website or web application people use in the browser." },
|
|
8
|
+
"required": ["features", "tech", "getting-started", "requirements", "install-steps", "author"],
|
|
9
|
+
"optional": ["demo", "screenshots", "testing", "usage", "env", "structure", "contributing", "acknowledgments", "license"],
|
|
10
|
+
"typeSpecific": []
|
|
11
|
+
},
|
|
12
|
+
{
|
|
13
|
+
"id": "course-example",
|
|
14
|
+
"name": { "zh-TW": "課程範例", "en": "Course example" },
|
|
15
|
+
"description": { "zh-TW": "上課或教學文章用的範例程式,學生會下載來照著做。", "en": "Example code for a class or tutorial that students download and follow." },
|
|
16
|
+
"required": ["learning-objectives", "tech", "getting-started", "requirements", "install-steps", "usage", "structure", "author"],
|
|
17
|
+
"optional": ["demo", "screenshots", "course-unit", "features", "testing", "start-finish", "env", "contributing", "acknowledgments", "license"],
|
|
18
|
+
"typeSpecific": ["learning-objectives", "course-unit", "start-finish", "usage"]
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"id": "portfolio",
|
|
22
|
+
"name": { "zh-TW": "作品集", "en": "Portfolio" },
|
|
23
|
+
"description": { "zh-TW": "求職或展示用的作品,讀者多半是面試官。", "en": "A project shown to employers or clients; the reader is often an interviewer." },
|
|
24
|
+
"required": ["screenshots", "features", "tech", "getting-started", "requirements", "install-steps", "author"],
|
|
25
|
+
"optional": ["demo", "my-role", "design-decisions", "testing", "usage", "env", "structure", "contributing", "acknowledgments", "license"],
|
|
26
|
+
"typeSpecific": ["my-role", "design-decisions"]
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"id": "backend-api",
|
|
30
|
+
"name": { "zh-TW": "後端 API", "en": "Backend API" },
|
|
31
|
+
"description": { "zh-TW": "提供資料給其他程式呼叫的伺服器,通常沒有自己的畫面。", "en": "A server that other programs call for data, usually without its own screens." },
|
|
32
|
+
"required": ["api-docs", "features", "tech", "getting-started", "requirements", "install-steps", "usage", "env", "structure", "author"],
|
|
33
|
+
"optional": ["demo", "testing", "database", "contributing", "acknowledgments", "license"],
|
|
34
|
+
"typeSpecific": ["api-docs", "database", "usage"]
|
|
35
|
+
}
|
|
36
|
+
]
|
|
37
|
+
}
|