pict-docuserve 0.0.27 → 0.0.28
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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pict-docuserve",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.28",
|
|
4
4
|
"description": "Pict Documentation Server - A single-page documentation viewer built on Pict",
|
|
5
5
|
"main": "source/Pict-Application-Docuserve.js",
|
|
6
6
|
"bin": {
|
|
@@ -18,25 +18,23 @@
|
|
|
18
18
|
"build-docs": "npx quack build && npx quack copy && node source/cli/Docuserve-CLI-Run.js inject ./docs && node example_applications/build-examples.js stage-docs",
|
|
19
19
|
"serve-docs": "node source/cli/Docuserve-CLI-Run.js serve ./docs",
|
|
20
20
|
"serve-examples": "node example_applications/build-examples.js",
|
|
21
|
-
"test": "npx
|
|
22
|
-
"tests": "npx
|
|
23
|
-
"coverage": "npx
|
|
21
|
+
"test": "npx quack test",
|
|
22
|
+
"tests": "npx quack test -g",
|
|
23
|
+
"coverage": "npx quack coverage"
|
|
24
24
|
},
|
|
25
25
|
"author": "steven velozo <steven@velozo.com>",
|
|
26
26
|
"license": "MIT",
|
|
27
27
|
"dependencies": {
|
|
28
28
|
"lunr": "^2.3.9",
|
|
29
|
-
"pict": "^1.0.
|
|
30
|
-
"pict-application": "^1.0.
|
|
31
|
-
"pict-provider": "^1.0.
|
|
32
|
-
"pict-section-content": "^0.0.
|
|
33
|
-
"pict-service-commandlineutility": "^1.0.
|
|
34
|
-
"pict-view": "^1.0.
|
|
29
|
+
"pict": "^1.0.355",
|
|
30
|
+
"pict-application": "^1.0.33",
|
|
31
|
+
"pict-provider": "^1.0.12",
|
|
32
|
+
"pict-section-content": "^0.0.7",
|
|
33
|
+
"pict-service-commandlineutility": "^1.0.19",
|
|
34
|
+
"pict-view": "^1.0.67"
|
|
35
35
|
},
|
|
36
36
|
"devDependencies": {
|
|
37
|
-
"
|
|
38
|
-
"mocha": "^11.7.5",
|
|
39
|
-
"quackage": "^1.0.51"
|
|
37
|
+
"quackage": "^1.0.58"
|
|
40
38
|
},
|
|
41
39
|
"copyFilesSettings": {
|
|
42
40
|
"whenFileExists": "overwrite"
|
|
@@ -61,7 +61,7 @@ class DocuserveApplication extends libPictApplication
|
|
|
61
61
|
let tmpDocProvider = this.pict.providers['Docuserve-Documentation'];
|
|
62
62
|
tmpDocProvider.loadCatalog(() =>
|
|
63
63
|
{
|
|
64
|
-
// Set the page title from
|
|
64
|
+
// Set the page title from _cover.md or _topbar.md
|
|
65
65
|
let tmpDocuserve = this.pict.AppData.Docuserve;
|
|
66
66
|
if (tmpDocuserve.CoverLoaded && tmpDocuserve.Cover && tmpDocuserve.Cover.Title)
|
|
67
67
|
{
|
|
@@ -57,10 +57,10 @@ class DocuserveDocumentationProvider extends libPictProvider
|
|
|
57
57
|
}
|
|
58
58
|
|
|
59
59
|
/**
|
|
60
|
-
* Load all documentation data sources: catalog,
|
|
60
|
+
* Load all documentation data sources: catalog, _cover.md, _sidebar.md.
|
|
61
61
|
*
|
|
62
62
|
* Loads the catalog first (it provides the fallback data), then attempts
|
|
63
|
-
* to load
|
|
63
|
+
* to load _cover.md and _sidebar.md in parallel. If those markdown files
|
|
64
64
|
* exist they drive the splash and sidebar views; otherwise the catalog
|
|
65
65
|
* data is used as a fallback.
|
|
66
66
|
*
|
|
@@ -74,7 +74,7 @@ class DocuserveDocumentationProvider extends libPictProvider
|
|
|
74
74
|
|
|
75
75
|
let tmpLoadOptionalFiles = () =>
|
|
76
76
|
{
|
|
77
|
-
// Load
|
|
77
|
+
// Load _cover.md, _sidebar.md, _topbar.md, errorpage.md and keyword index in parallel.
|
|
78
78
|
// When all are done, if we still have no sidebar data, try to auto-discover
|
|
79
79
|
// a README.md so the site works with plain markdown folders.
|
|
80
80
|
let tmpPending = 5;
|
|
@@ -205,9 +205,9 @@ class DocuserveDocumentationProvider extends libPictProvider
|
|
|
205
205
|
}
|
|
206
206
|
|
|
207
207
|
/**
|
|
208
|
-
* Fetch and parse
|
|
208
|
+
* Fetch and parse _cover.md into structured data for the splash view.
|
|
209
209
|
*
|
|
210
|
-
* The expected
|
|
210
|
+
* The expected _cover.md format follows the docsify convention:
|
|
211
211
|
* # Title
|
|
212
212
|
* > Tagline
|
|
213
213
|
* Description paragraph text.
|
|
@@ -224,7 +224,7 @@ class DocuserveDocumentationProvider extends libPictProvider
|
|
|
224
224
|
let tmpCallback = (typeof(fCallback) === 'function') ? fCallback : () => {};
|
|
225
225
|
let tmpDocsBase = this.pict.AppData.Docuserve.DocsBaseURL || '';
|
|
226
226
|
|
|
227
|
-
fetch(tmpDocsBase + '
|
|
227
|
+
fetch(tmpDocsBase + '_cover.md')
|
|
228
228
|
.then((pResponse) =>
|
|
229
229
|
{
|
|
230
230
|
if (!pResponse.ok)
|
|
@@ -237,7 +237,7 @@ class DocuserveDocumentationProvider extends libPictProvider
|
|
|
237
237
|
{
|
|
238
238
|
if (!pMarkdown)
|
|
239
239
|
{
|
|
240
|
-
this.log.info('Docuserve: No
|
|
240
|
+
this.log.info('Docuserve: No _cover.md found; splash will use catalog data.');
|
|
241
241
|
return tmpCallback();
|
|
242
242
|
}
|
|
243
243
|
|
|
@@ -247,15 +247,15 @@ class DocuserveDocumentationProvider extends libPictProvider
|
|
|
247
247
|
})
|
|
248
248
|
.catch((pError) =>
|
|
249
249
|
{
|
|
250
|
-
this.log.warn(`Docuserve: Error loading
|
|
250
|
+
this.log.warn(`Docuserve: Error loading _cover.md: ${pError}`);
|
|
251
251
|
return tmpCallback();
|
|
252
252
|
});
|
|
253
253
|
}
|
|
254
254
|
|
|
255
255
|
/**
|
|
256
|
-
* Parse
|
|
256
|
+
* Parse _cover.md markdown text into a structured object.
|
|
257
257
|
*
|
|
258
|
-
* @param {string} pMarkdown - Raw
|
|
258
|
+
* @param {string} pMarkdown - Raw _cover.md content
|
|
259
259
|
* @returns {Object} Parsed cover data
|
|
260
260
|
*/
|
|
261
261
|
parseCover(pMarkdown)
|
|
@@ -162,7 +162,7 @@ class DocusserveSplashView extends libPictView
|
|
|
162
162
|
}
|
|
163
163
|
|
|
164
164
|
/**
|
|
165
|
-
* Render the splash screen from parsed
|
|
165
|
+
* Render the splash screen from parsed _cover.md data.
|
|
166
166
|
*
|
|
167
167
|
* @param {Object} pCover - The parsed cover data { Title, Tagline, Description, Highlights, Actions }
|
|
168
168
|
*/
|
|
@@ -212,7 +212,7 @@ class DocusserveSplashView extends libPictView
|
|
|
212
212
|
}
|
|
213
213
|
|
|
214
214
|
/**
|
|
215
|
-
* Render the splash screen from catalog data as a fallback when
|
|
215
|
+
* Render the splash screen from catalog data as a fallback when _cover.md
|
|
216
216
|
* is not available.
|
|
217
217
|
*
|
|
218
218
|
* @param {Object} pDocuserve - The AppData.Docuserve state
|