honkit 6.2.2 → 6.2.4

package/lib/output/__tests__/website.js

@@ -14,6 +14,23 @@ describe("WebsiteGenerator", () => {
         });
         expect(folder).toHaveFile("index.html");
     }, 60 * 1000);
+    longTest("should use structure.readme for index.html even if README.md exists", () => {
+        return (0, generateMock_1.default)(website_1.default, {
+            "book.json": "{ \"structure\": { \"readme\": \"README.other.md\" } }",
+            "SUMMARY.md": "# Summary\n\n* [Default README](README.md)",
+            "README.md": "default readme content",
+            "README.other.md": "custom readme content"
+        }).then((folder) => {
+            expect(folder).toHaveFile("index.html");
+            expect(folder).toHaveFile("README.html");
+            const index = fs_1.default.readFileSync(`${folder}/index.html`, "utf8");
+            expect(index).toContain("custom readme content");
+            expect(index).not.toContain("default readme content");
+            expect(index).toHaveDOMElement(".book-summary a[href=\"README.html\"]");
+            const readme = fs_1.default.readFileSync(`${folder}/README.html`, "utf8");
+            expect(readme).toContain("default readme content");
+        });
+    });
     describe("Glossary", () => {
         let folder;
         beforeAll(() => {

package/lib/output/helper/fileToOutput.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fileToOutput.d.ts","sourceRoot":"","sources":["../../../src/output/helper/fileToOutput.ts"],"names":[],"mappings":"AAMA;;;;;;GAMG;AAEH,iBAAS,YAAY,CAAC,MAAM,KAAA,EAAE,QAAQ,KAAA,UAerC;AAED,eAAe,YAAY,CAAC"}
+{"version":3,"file":"fileToOutput.d.ts","sourceRoot":"","sources":["../../../src/output/helper/fileToOutput.ts"],"names":[],"mappings":"AAMA;;;;;;GAMG;AAEH,iBAAS,YAAY,CAAC,MAAM,KAAA,EAAE,QAAQ,KAAA,UAkBrC;AAED,eAAe,YAAY,CAAC"}

package/lib/output/helper/fileToOutput.js

@@ -18,8 +18,12 @@ function fileToOutput(output, filePath) {
     const book = output.getBook();
     const readme = book.getReadme();
     const fileReadme = readme.getFile();
-    if (path_1.default.basename(filePath, path_1.default.extname(filePath)) == "README" ||
-        (fileReadme.exists() && filePath == fileReadme.getPath())) {
+    const isBookReadme = fileReadme.exists() && filePath == fileReadme.getPath();
+    // Other README files become the index of their directory too,
+    // except where the book readme (structure.readme) already uses that index
+    const isDirectoryReadme = path_1.default.basename(filePath, path_1.default.extname(filePath)) == "README" &&
+        !(fileReadme.exists() && path_1.default.dirname(filePath) == path_1.default.dirname(fileReadme.getPath()));
+    if (isBookReadme || isDirectoryReadme) {
         filePath = path_1.default.join(path_1.default.dirname(filePath), `index${OUTPUT_EXTENSION}`);
     }
     else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "honkit",
-  "version": "6.2.2",
+  "version": "6.2.4",
   "description": "HonKit is building beautiful books using Markdown.",
   "keywords": [
     "git",
@@ -70,12 +70,12 @@
     "semver": "^7.6.3",
     "send": "^0.19.2",
     "tiny-lr": "^1.1.1",
-    "@honkit/honkit-plugin-fontsettings": "6.2.2",
-    "@honkit/honkit-plugin-highlight": "6.2.2",
-    "@honkit/asciidoc": "6.2.2",
-    "@honkit/honkit-plugin-theme-default": "6.2.2",
-    "@honkit/html": "6.2.2",
-    "@honkit/markdown-legacy": "6.2.2"
+    "@honkit/asciidoc": "6.2.4",
+    "@honkit/honkit-plugin-fontsettings": "6.2.4",
+    "@honkit/honkit-plugin-theme-default": "6.2.4",
+    "@honkit/html": "6.2.4",
+    "@honkit/honkit-plugin-highlight": "6.2.4",
+    "@honkit/markdown-legacy": "6.2.4"
   },
   "devDependencies": {
     "@relmify/jest-serializer-strip-ansi": "^1.0.2",
@@ -87,7 +87,7 @@
     "object-path": "^0.11.8",
     "rimraf": "^6.0.1",
     "typescript": "^5.6.2",
-    "@honkit/internal-test-utils": "6.2.2"
+    "@honkit/internal-test-utils": "6.2.4"
   },
   "scripts": {
     "build": "tsc -p .",