@honkit/honkit-plugin-theme 5.1.0

package/_layouts/website/page.html

@@ -0,0 +1,96 @@
+{% extends "./layout.html" %}
+
+{% block title %}{{ page.title }} · {{ super() }}{% endblock %}
+
+{% block description %}{{ page.description }}{% endblock %}
+
+{% block head %}
+{{ super() }}
+{% if page.next and page.next.path %}
+<link rel="next" href="{{ page.next.path|resolveFile }}" />
+{% endif %}
+{% if page.previous and page.previous.path %}
+<link rel="prev" href="{{ page.previous.path|resolveFile }}" />
+{% endif %}
+{% endblock %}
+
+{% block javascript %}
+<script>
+    window.honkit = {};
+    window.honkit.metadata = {{ template.getJSContext()|dump|safe }};
+</script>
+<script src="{{ 'theme.js'|resolveAsset }}"></script>
+{% for resource in plugins.resources.js %}
+{% if resource.url %}
+<script src="{{ resource.url }}"></script>
+{% else %}
+<script src="{{ resource.path|resolveAsset }}"></script>
+{% endif %}
+{% endfor %}
+{% endblock %}
+
+{% block body %}
+<div class="book">
+    <div class="book-summary">
+        {% block book_sidebar %}
+        {% block search_input %}{% endblock %}
+        {% block book_summary %}
+        <nav role="navigation">
+            {% include "website/summary.html" %}
+        </nav>
+        {% endblock %}
+        {% endblock %}
+    </div>
+
+    <div class="book-body">
+        {% block book_body %}
+        <div class="body-inner">
+            {% block book_inner %}
+            {% include "website/header.html" %}
+
+            <div class="page-wrapper" tabindex="-1" role="main">
+                <div class="page-inner">
+                    {% block search_results %}
+                    <section class="normal markdown-section">
+                        {% block page %}
+                        {{ page.content|safe }}
+                        {% endblock %}
+                    </section>
+                    {% block book_navigation %}
+                    <div class="bottom-navigation">
+                        {% if page.previous and page.previous.path %}
+                        <a href="{{ page.previous.path|resolveFile }}{{ page.previous.anchor }}"
+                           class="bottom-navigation---prev-link navigation navigation-prev {% if not (page.next and page.next.path) %}navigation-unique{% endif %}"
+                           aria-label="Previous page: {{ page.previous.title }}">
+                            <div>
+                                <div class="bottom-navigation--prev-sublabel">Previous</div>
+                                <div class="bottom-navigation--prev-label">
+                                    {{ page.previous.title }}
+                                </div>
+                            </div>
+                        </a>
+                        {% endif %}
+
+                        {% if page.next and page.next.path %}
+                        <a href="{{ page.next.path|resolveFile }}{{ page.next.anchor }}"
+                           class="bottom-navigation---next-link navigation navigation-next {% if not (page.previous and page.previous.path) %}navigation-unique{% endif %}"
+                           aria-label="Next page: {{ page.next.title }}">
+                            <div>
+                                <div class="bottom-navigation--next-sublabel">Next</div>
+                                <div class="bottom-navigation--next-label">
+                                    {{ page.next.title }}
+                                </div>
+                            </div>
+                        </a>
+                        {% endif %}
+                    </div>
+                    {% endblock %}
+                    {% endblock %}
+                </div>
+            </div>
+            {% endblock %}
+        </div>
+        {% endblock %}
+    </div>
+</div>
+{% endblock %}

package/_layouts/website/summary.html

@@ -0,0 +1,61 @@
+{% macro articles(_articles) %}
+    {% for article in _articles %}
+        <li class="chapter {% if article.path == file.path and not article.anchor %}active{% endif %}" data-level="{{ article.level }}" {% if article.path %}data-path="{{ article.path|resolveFile }}"{% endif %}>
+            {% if article.path and getPageByPath(article.path) %}
+                <a href="{{ article.path|resolveFile }}{{ article.anchor }}">
+            {% elif article.url %}
+                <a href="{{ article.url }}" target="_blank" rel="noopener">
+            {% else %}
+                <span>
+            {% endif %}
+                    {% if article.level != "0" and config.pluginsConfig['theme-default'].showLevel %}
+                        <b>{{ article.level }}.</b>
+                    {% endif %}
+                    {{ article.title }}
+            {% if article.path  or article.url %}
+                </a>
+            {% else %}
+                </span>
+            {% endif %}
+
+            {% if article.articles.length > 0 %}
+            <ul class="articles">
+                {{ articles(article.articles, file, config) }}
+            </ul>
+            {% endif %}
+        </li>
+    {% endfor %}
+{% endmacro %}
+
+<ul class="summary">
+    {% set _divider = false %}
+    {% if config.links.sidebar  %}
+    {% for linkTitle, link in config.links.sidebar  %}
+        {% set _divider = true %}
+        <li>
+            <a href="{{ link }}" target="_blank" rel="noopener" class="custom-link">{{ linkTitle }}</a>
+        </li>
+    {% endfor %}
+    {% endif %}
+
+    {% if _divider %}
+    <li class="divider"></li>
+    {% endif %}
+
+    {% for part in summary.parts %}
+        {% if part.title %}
+        <li class="header">{{ part.title }}</li>
+        {% elif not loop.first %}
+        <li class="divider"></li>
+        {% endif %}
+        {{ articles(part.articles, file, config) }}
+    {% endfor %}
+
+    <li class="divider"></li>
+
+    <li>
+        <a href="https://github.com/honkit/honkit" target="_blank" rel="noopener" class="gitbook-link">
+            {{ "GITBOOK_LINK"|t }}
+        </a>
+    </li>
+</ul>

package/index.js

@@ -0,0 +1,8 @@
+module.exports = {
+    hooks: {
+        config: function (config) {
+            config.styles = config.styles || config.pluginsConfig["@honkit/honkit-plugin-theme"].styles;
+            return config;
+        }
+    }
+};

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@honkit/honkit-plugin-theme",
+  "version": "5.1.0",
+  "description": "Default theme for HonKit",
+  "bugs": {
+    "url": "https://github.com/honkit/honkit/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/honkit/honkit.git"
+  },
+  "license": "Apache-2.0",
+  "author": "azu <azuciao@gmail.com>",
+  "main": "./index.js",
+  "files": [
+    "index.js",
+    "_assets",
+    "_i18n",
+    "_layouts",
+    "!__tests__"
+  ],
+  "scripts": {
+    "prebuild": "npm run clean",
+    "build": "npm-run-all build:js build:css cp",
+    "build:css": "npm-run-all -p build:css:*",
+    "build:css:ebook": "lessc -clean-css src/less/ebook.less _assets/ebook/ebook.css",
+    "build:css:epub": "lessc -clean-css src/less/epub.less _assets/ebook/epub.css",
+    "build:css:mobi": "lessc -clean-css src/less/mobi.less _assets/ebook/mobi.css",
+    "build:css:pdf": "lessc -clean-css src/less/pdf.less _assets/ebook/pdf.css",
+    "build:css:website": "lessc -clean-css src/less/website.less _assets/website/style.css",
+    "build:js": "esbuild src/js/theme/index.js --bundle --minify --outfile=_assets/website/theme.js",
+    "clean": "rimraf _assets && mkdirp _assets/ebook/ _assets/website/ _assets/website/fonts _assets/website/images",
+    "cp": "npm-run-all -p cp:*",
+    "cp:favicon": "cpy --flat logo/favicon.ico _assets/website/images/",
+    "cp:logo": "cpy --flat logo/apple-touch-icon.png _assets/website/images/ --rename=apple-touch-icon-precomposed-152.png",
+    "prepublish": "npm run build"
+  },
+  "devDependencies": {
+    "cpy-cli": "^4.2.0",
+    "esbuild": "^0.18.13",
+    "gitbook-markdown-css": "^1.1.0",
+    "less": "2.7.1",
+    "less-plugin-clean-css": "1.5.1",
+    "mkdirp": "^1.0.4",
+    "npm-run-all": "^4.1.5",
+    "rimraf": "^3.0.2"
+  },
+  "engines": {
+    "gitbook": ">=3.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitbook": {
+    "properties": {
+      "styles": {
+        "type": "object",
+        "title": "Custom Stylesheets",
+        "properties": {
+          "website": {
+            "title": "Stylesheet for website output",
+            "default": "styles/website.css"
+          },
+          "pdf": {
+            "title": "Stylesheet for PDF output",
+            "default": "styles/pdf.css"
+          },
+          "epub": {
+            "title": "Stylesheet for ePub output",
+            "default": "styles/epub.css"
+          },
+          "mobi": {
+            "title": "Stylesheet for Mobi output",
+            "default": "styles/mobi.css"
+          },
+          "ebook": {
+            "title": "Stylesheet for ebook outputs (PDF, ePub, Mobi)",
+            "default": "styles/ebook.css"
+          },
+          "print": {
+            "title": "Stylesheet to replace default ebook css",
+            "default": "styles/print.css"
+          }
+        }
+      },
+      "showLevel": {
+        "type": "boolean",
+        "title": "Show level indicator in TOC",
+        "default": false
+      }
+    }
+  },
+  "gitHead": "6acb1146ae4c21d64283f88f06f26427a35f349b"
+}