Merge pull request #192 from qmlbook/main

Release the pdf for Contributors' Summit

Author: e8johan

.gitignore

@@ -117,3 +117,4 @@ __pycache__
 
 # Qt Shaders
 *.qsb
+qt6book.pdf

assets/frontpage.jpg

@@ -2,7 +2,15 @@ module.exports = {
   title: 'The Qt 6 Book',
   description: "A book about QML",  
   plugins: [
-    'vuepress-plugin-mermaidjs'
+    'vuepress-plugin-mermaidjs',
+    [ '@e8johan/vuepress-plugin-pdf-export', {
+        puppeteerLaunchOptions: { args: [ '--no-sandbox', '--disable-setuid-sandbox' ] },
+        outputFileName: 'qt6book.pdf',
+        sorter: (a, b) => { return pageSorter(a.relativePath, b.relativePath); },
+        filter: (p) => { return pageFilter(p.relativePath); },
+        tocLevel: (p) => { return tocLevel(p.relativePath); },
+        frontPage: 'assets/frontpage.pdf',
+    }],
   ],  
   themeConfig: {
     displayAllHeaders: false,
@@ -16,7 +24,69 @@ module.exports = {
     lastUpdated: 'Last Updated',
     nav: [
     ],
-    sidebar: [
+    sidebar: sidebarOrder(),
+  },
+}
+
+function _pageOrder() {
+    pageOrder = []
+
+    const chapterOrder = sidebarOrder();
+    chapterOrder.forEach(chapter => {
+        pages = chapter.children
+        pages.forEach(page => pageOrder.push(page));
+    });
+
+    return pageOrder;
+}
+
+function tocLevel(p) {
+    const tocTopLevel = sidebarOrder().map(s => { return s.path; });
+    if (p.endsWith('.md'))
+        p = '/' + p.slice(0, -3)
+    if (tocTopLevel.indexOf(p) != -1)
+        return 0;
+    else
+        return 1;
+}
+
+function pageFilter(p) {
+    const pageOrder = _pageOrder()
+
+    if (p.endsWith('.md'))
+        p = '/' + p.slice(0, -3);
+
+    const indexP = pageOrder.indexOf(p);
+
+    return (indexP != -1);
+}
+
+function pageSorter(a, b) {
+    const pageOrder = _pageOrder();
+
+    if (a.endsWith('.md'))
+        a = '/' + a.slice(0, -3);
+    if (b.endsWith('.md'))
+        b = '/' + b.slice(0, -3);
+
+    const indexA = pageOrder.indexOf(a);
+    const indexB = pageOrder.indexOf(b);
+
+    if (indexA == -1)
+        console.log("Page not found in index " + a);
+    if (indexB == -1)
+        console.log("Page not found in index " + b);
+
+    if (indexA < indexB)
+        return -1;
+    if (indexA > indexB)
+        return 1;
+
+    return 0;
+}
+
+function sidebarOrder() {
+    return [
       prefaceSidebar(),
       ch01Sidebar(),
       ch02Sidebar(),
@@ -38,8 +108,7 @@ module.exports = {
       ch18Sidebar(),
       ch19Sidebar(),
       ch20Sidebar(),
-    ],
-  },  
+    ];
 }
 
 function ch20Sidebar() {

assets/frontpage.pdf

@@ -0,0 +1,35 @@
+@media print {
+
+/* The page */
+@page {
+    size: portrait;
+
+    margin-left: 2.54cm;
+    margin-right: 2.54cm;
+    margin-top: 2.54cm;
+    margin-bottom: 3.76cm;
+}
+
+/* Tips, caveats, etc */
+div.custom-block {
+    /* Avoid page-breaks */
+    page-break-inside: avoid;
+}
+
+/* All images */
+img {
+    /* Center */
+    display: block;
+    margin-left: auto;
+    margin-right: auto;
+
+    /* Avoid page-breaks */
+    page-break-inside: avoid;
+}
+
+/* Print links */
+p a::after {
+    content: " (" attr(href) ") ";
+}
+
+}

docs/.vuepress/config.js

@@ -14,8 +14,13 @@
   "scripts": {
     "docs:dev": "vuepress dev docs --host 127.0.0.1",
     "docs:build": "vuepress build docs",
+    "docs:pdf": "vuepress export docs",
     "examples:build": "./scripts/build-examples.sh",
     "examples:lint": "./scripts/lint-examples.sh",
     "examples:package": "./scripts/package-examples.sh"
+  },
+  "dependencies": {
+    "@e8johan/vuepress-plugin-pdf-export": "^1.4.0",
+    "vuepress-plugin-export": "^0.2.0"
   }
 }