web-documentation 1.0.27 → 1.0.28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "web-documentation",
-  "version": "1.0.27",
+  "version": "1.0.28",
   "description": "Declarative multilanguage documentation website generator",
   "keywords": [
     "documentation",
@@ -204,9 +204,8 @@
         "ejs": {
           "options": {
             "locals": {
-              "API_DOCUMENTATION_PATH": {
-                "__evaluate__": "path.resolve(currentPath, 'api/')"
-              },
+              "API_DOCUMENTATION_PATH": "api/",
+              "HAS_API_DOCUMENTATION": true,
               "CONTENT": "source/dummyReadme.md",
               "DISTRIBUTION_BUNDLE_FILE_PATH": "dummyDistributionBundle.zip",
               "LANGUAGES": {

package/source/deploy.ts

@@ -88,7 +88,7 @@ const BUILD_DOCUMENTATION_PAGE_CONFIGURATION = {
         }
     },
     /*
-        NOTE: We habe to disable offline features since the domains cache is
+        NOTE: We have to disable offline features since the domains cache is
         already in use for the main home page.
     */
     offline: null
@@ -179,7 +179,7 @@ const stream2buffer = async (stream: Stream): Promise<Buffer> => {
  * @param temporaryDocumentationFolderPath - Location where to build
  * documentation build.
  * @param distributionBundleFilePath - Location where to save the exported
- * build artefacts.
+ * build artifacts.
  * @returns A promise resolving when build process has finished.
  */
 const generateAndPushNewDocumentationPage = async (
@@ -259,6 +259,7 @@ const generateAndPushNewDocumentationPage = async (
         ...parameters,
         CONTENT,
         API_DOCUMENTATION_PATH: apiDocumentationPath,
+        HAS_API_DOCUMENTATION,
         DISTRIBUTION_BUNDLE_FILE_PATH:
             await isFile(DISTRIBUTION_BUNDLE_FILE_PATH) ?
                 relative('./', DISTRIBUTION_BUNDLE_FILE_PATH) :
@@ -721,7 +722,7 @@ const main = async (): Promise<void> => {
             Boolean(SCOPE.scripts) &&
             Object.prototype.hasOwnProperty.call(SCOPE.scripts, 'build')
         )
-            // Prepare build artefacts for further local usage.
+            // Prepare build artifacts for further local usage.
             log.debug(run('yarn build'))
     }
 }

package/source/index.html.ejs

@@ -115,10 +115,7 @@ _%>
                                 numberOfLanguageLinks = _.LANGUAGES.length
                                 START_UP_ANIMATION_NUMBER += numberOfLanguageLinks
                             }
-                            if (
-                                _.API_DOCUMENTATION_PATH &&
-                                _.IS_DIRECTORY(_.API_DOCUMENTATION_PATH)
-                            )
+                            if (_.HAS_API_DOCUMENTATION)
                                 START_UP_ANIMATION_NUMBER += 3
                             else
                                 START_UP_ANIMATION_NUMBER += 2
@@ -158,12 +155,8 @@ _%>
                                         class="header__inner__links__lang tools-hidden-on-javascript-disabled wu-start-up-animation-number-<%- START_UP_ANIMATION_NUMBER %>"
                                         href="#lang-<%- language %>"
                                     ><%- language.slice(0, 2) %></a>
-                        <%_      }
-                            if (
-                                _.API_DOCUMENTATION_PATH &&
-                                _.IS_DIRECTORY(_.API_DOCUMENTATION_PATH)
-                            ) {
-                        _%>
+                                <%_ } _%>
+                            <%_ if (_.HAS_API_DOCUMENTATION) { _%>
                                 <%_ START_UP_ANIMATION_NUMBER -= 1 _%>
                                 <a
                                     class="header__inner__links__api-link wu-start-up-animation-number-<%- START_UP_ANIMATION_NUMBER %>"