web-documentation 1.0.22 → 1.0.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "web-documentation",
-  "version": "1.0.22",
+  "version": "1.0.24",
   "description": "Declarative multilanguage documentation website generator",
   "keywords": [
     "documentation",
@@ -68,7 +68,7 @@
     "@webcomponents/webcomponentsjs": "^2.8.0",
     "archiver": "^8.0.0",
     "bootstrap-icons": "^1.13.1",
-    "clientnode": "^4.0.1411",
+    "clientnode": "^4.0.1413",
     "css-loader": "^7.1.4",
     "cssnano": "^8.0.1",
     "default-gateway": "^7.2.2",
@@ -204,7 +204,7 @@
         "ejs": {
           "options": {
             "locals": {
-              "API_DOCUMENTATION_PATH": "/apiDocumentation/",
+              "API_DOCUMENTATION_PATH": "/api/",
               "CONTENT": "source/dummyReadme.md",
               "DISTRIBUTION_BUNDLE_FILE_PATH": "dummyDistributionBundle.zip",
               "LANGUAGES": {

package/source/deploy.ts

@@ -497,7 +497,11 @@ const tidyUp = async (): Promise<void> => {
         HAS_API_DOCUMENTATION &&
         !(await isDirectory(oldAPIDocumentationDirectoryPath))
     )
-        run(`git checkout '${oldAPIDocumentationDirectoryPath}'`)
+        try {
+            run(`git checkout '${oldAPIDocumentationDirectoryPath}'`)
+        } catch (error) {
+            log.warn(error)
+        }
 
     if (!run('git branch').includes('* main'))
         log.debug(run('git checkout main'))
@@ -574,12 +578,16 @@ const main = async (): Promise<void> => {
         HAS_API_DOCUMENTATION =
             Boolean(SCOPE.scripts) &&
             Object.prototype.hasOwnProperty.call(SCOPE.scripts, 'document')
-        if (HAS_API_DOCUMENTATION)
+        if (HAS_API_DOCUMENTATION) {
+            log.info('API documentation creation script detected.')
             try {
                 log.debug(run('yarn document'))
-            } catch {
+                log.info('API documentation created.')
+            } catch (error) {
+                log.warn(error)
                 HAS_API_DOCUMENTATION = false
             }
+        }
 
         log.debug(run('git checkout gh-pages'))
         log.debug(run('git pull'))
@@ -677,13 +685,19 @@ const main = async (): Promise<void> => {
         log.debug(
             run('corepack install', {cwd: temporaryDocumentationFolderPath})
         )
-        log.debug(run(
-            'yarn install',
-            {
-                cwd: temporaryDocumentationFolderPath,
-                env: {...process.env, NODE_ENV: 'debug'}
-            }
-        ))
+
+        try {
+            log.debug(run(
+                'yarn install',
+                {
+                    cwd: temporaryDocumentationFolderPath,
+                    env: {...process.env, NODE_ENV: 'debug'}
+                }
+            ))
+        } catch (error) {
+            log.warn(error)
+        }
+
         log.debug(run('yarn clear', {cwd: temporaryDocumentationFolderPath}))
 
         await generateAndPushNewDocumentationPage(

package/source/dummyReadme.md

@@ -60,7 +60,9 @@ You need utilities for:<!--deDE:Sie benötigen Hilfsfunktionen für:-->
 - URLs
 
 <!--Place for automatic generated table of contents.-->
-<div class="doc-toc" style="display:none">
+<!--Backend generated one indicator: "# heading"-->
+<!--Clientside generated version indicator:-->
+<div class="doc-toc" style="display: none">
     <!--|deDE:Inhalt-->
     <h2 id="content">Content</h2>
 </div>
@@ -69,9 +71,6 @@ You need utilities for:<!--deDE:Sie benötigen Hilfsfunktionen für:-->
 Installation
 ------------
 
-<!--|deDE:Klassische Dom-Integration-->
-### Classical dom injection
-
 You can install via package manager, simply download the compiled version as
 zip file here and inject or request via cdn in HTML:
 <!--deDE:

package/source/index.ts

@@ -237,7 +237,8 @@ export class WebDocumentation<
         if (!this.tableOfContentDomNode)
             return
 
-        let listItems = '<ul>'
+        let listItemsHTML = ''
+
         let level = 0
         let firstLevel = 0
         let first = true
@@ -252,12 +253,14 @@ export class WebDocumentation<
             if (first)
                 firstLevel = newLevel
 
+            console.log('A', newLevel)
+
             if (newLevel > level)
-                listItems += '<ul>'
+                listItemsHTML += '<ul>'
             else if (newLevel < level)
-                listItems += '</ul>'
+                listItemsHTML += '</ul>'
 
-            listItems += `
+            listItemsHTML += `
                 <li>
                     <a href="#${domNode.getAttribute('id') ?? 'unknown'}">
                         ${domNode.innerText}
@@ -270,13 +273,11 @@ export class WebDocumentation<
         }
         // Close remaining inner lists.
         while (level < firstLevel) {
-            listItems += '</ul>'
+            listItemsHTML += '</ul>'
             level += 1
         }
 
-        listItems += '</ul>'
-
-        this.tableOfContentDomNode.append(createDomNodes(listItems))
+        this.tableOfContentDomNode.append(createDomNodes(listItemsHTML))
 
         this.tableOfContentLinkDomNodes =
             this.tableOfContentDomNode.querySelectorAll<HTMLAnchorElement>(

package/source/renderMarkdown.mjs

@@ -22,8 +22,32 @@ const marked = new Marked(
 
 export default (options) => {
     marked.setOptions(options)
-    // Include an id attribute when emitting headings (h1, h2, h3, etc).
-    marked.use(gfmHeadingId({prefix: 'doc-'}))
+    // Include an id attribute when emitting headings (h1, h2, h3, ...).
+    marked.use(gfmHeadingId(
+        {prefix: 'doc-'}/* TODO,
+
+    {
+        hooks: {
+            postprocess(html) {
+                const headings = getHeadingList()
+
+
+                    NOTE: We do not wrap with an initial UL tag since H1
+                    should be ignored. It is only existing once for SEO
+                    purposes.
+                * /
+                    return `
+                        ${headings.map(({
+                            id,
+                            raw,
+                            level
+                        }) => `<li><a href="#${id}">${raw}</a></li>`)}
+                        ${html}
+                    `
+                }
+            }
+        }*/
+    ))
     // Favors self-closing xhtml tags.
     marked.use(markedXhtml())