jekyll-theme-gitbook 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a6efdeacd85eb499cce5307098b92cf20e7eef3458ff75878aed59b8b9579dd
-  data.tar.gz: 83c13ca9dc58ccab2291f74e02cbdbbbb4201685b64b9d61445d47f4a5af3edf
+  metadata.gz: 4e55032d1d46d8f8a1b6c58ab2a53e60d2aad1dd297f16c1bae5b83be0d309e8
+  data.tar.gz: 4d51893394120d5efeaf0b2284fa48a238fcf35c123fc862274e13edde266afa
 SHA512:
-  metadata.gz: f993ea2fd89503b9251f44fd0cbd0c2d1e7446cce2b48c3a7c6af8b697ca4a16630bf286b2ea11a50044226733b934980eab1bc3716d19b8153e7da418ce2f46
-  data.tar.gz: a650914b667f87d35796cea2c242e1ccc56216f396129a5946ccf3566cf15d04b0c59b4208e67980c65d413a34a10a4c81ab1ac4b8c8a7b78275aa45a9ac9d7e
+  metadata.gz: a4173c81205c974d250d58ac5bfa3cc7bce37f1ceb85296c7fae49ed41f2d19270a6f4047e94c1e0ea328b85ffeba3dfad82c38ffeed9eb2b6be26a29aad0fb0
+  data.tar.gz: e882279dad7d78c92f928c521c85afe102b6077b143e6a734dcafd3fafc588fb6bd55d30804cdffa683ae84866d1faba4308a41361b5ed74cdbe77ee4d64445d

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Adam Rehn
+Copyright (c) 2020 - 2022 Adam Rehn
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -4,6 +4,8 @@ This is a documentation theme for [Jekyll](https://jekyllrb.com/) that takes its
 
 This theme is designed to be highly configurable, whilst providing sensible defaults for most options in order to make it as easy as possible to get up and running quickly. See the [Configuration](#configuration) section for details of the available settings.
 
+**You can view a [live demo of this theme here](https://adamrehn.github.io/jekyll-theme-gitbook-demo) and view the [source code for the demo site here](https://github.com/adamrehn/jekyll-theme-gitbook-demo).**
+
 
 ## Contents
 
@@ -32,7 +34,7 @@ This theme is designed to be highly configurable, whilst providing sensible defa
 If you are hosting your site on GitHub Pages then add the following line to your site's `_config.yml` file (as per [the documentation](https://docs.github.com/en/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll)):
 
 ```yaml
-remote_theme: "adamrehn/jekyll-theme-gitbook"
+remote_theme: "adamrehn/jekyll-theme-gitbook@v0.0.3"
 ```
 
 ### Other hosts (e.g. GitLab Pages)
@@ -186,8 +188,6 @@ defaults:
       # An icon is optional and will be displayed next to the chapter name if specified
       icon: "fas fa-school"
       
-      # A blurb is optional and will be displayed if you generate a list of chapters with the `chapter-list.html` include
-      blurb: "This category covers basic topics."
   -
     scope:
       path: "_collections/_categories/intermediate"
@@ -195,7 +195,6 @@ defaults:
       chapter: "Intermediate"
       chapnum: 2
       icon: "fas fa-university"
-      blurb: "This category covers intermediate topics."
   -
     scope:
       path: "_collections/_categories/advanced"
@@ -203,7 +202,6 @@ defaults:
       chapter: "Advanced"
       chapnum: 3
       icon: "fas fa-graduation-cap"
-      blurb: "This category covers advanced topics."
 ```
 
 ### Site structure
@@ -235,21 +233,25 @@ Page content goes here.
 
 #### Content structure: chapters
 
-Each chapter should also include an `index.html` file, which should specify either the `chapter-index` or `chapter-redirect` layout and nothing else:
+Each chapter should also include an `index.html` file, which should specify either the `chapter-index` or `chapter-redirect` layout and can optionally include a chapter description:
 
 ```yaml
 ---
 layout: chapter-redirect
 ---
+
+Optional description of this chapter goes here.
 ```
 
 The layout you choose will determine the site's behaviour when navigating to the index for a chapter (which is resolved automatically when referencing a subdirectory's path without a trailing page path.) Choose the `chapter-index` layout if you would like the web browser to display a list of links to the pages in the chapter, or the `chapter-redirect` layout if you would like the web browser to automatically redirect to the first page in the chapter.
 
-If you use the `chapter-index` layout for a chapter and the global setting `theme-settings.indices` is set to `true` then a navigation link will be generated for the chapter index.
+If you choose to provide a chapter description then this will be displayed on the chapter's index page when using the `chapter-index` layout, and will also be displayed under the chapter's name if you generate a list of chapters with the `chapter-list.html` include (which is designed to be used on the front page of a site.)
+
+If you use the `chapter-index` layout for a chapter and the global setting `theme-settings.indices` is set to `true` then a link will be generated for the chapter index in the site's navigation sidebar.
 
 #### Content structure: site root
 
-You can specify custom content for the site's front page by providing an `index.html` or `index.md` file in the root of your site's filesystem directory. The `chapter-list.html` include that ships with the theme is designed for use from the site root, and generates a list of chapters for you (with per-chapter `blurb` values included if they were specified.)
+You can specify custom content for the site's front page by providing an `index.html` or `index.md` file in the root of your site's filesystem directory. The `chapter-list.html` include that ships with the theme is designed for use from the site root, and generates a list of chapters for you (with per-chapter descriptions included if they were specified.)
 
 If you do not want to have a custom front page then you can use the `root-redirect` layout to instruct web browsers to automatically redirect to the index of the first chapter (which may in turn redirect to the first page of that chapter if you specified that behaviour, as discussed in the previous section):
 
@@ -298,7 +300,7 @@ The theme supports the following advanced configuration options:
 
 ## Legal
 
-Copyright © 2020, Adam Rehn. Licensed under the MIT License, see the file [LICENSE](https://github.com/adamrehn/jekyll-theme-gitbook/blob/master/LICENSE) for details.
+Copyright © 2020 - 2022, Adam Rehn. Licensed under the MIT License, see the file [LICENSE](https://github.com/adamrehn/jekyll-theme-gitbook/blob/master/LICENSE) for details.
 
 The following third-party libraries are bundled in the theme's source tree and are covered by their respective licenses:
 

data/_includes/internal/postprocessing.html

@@ -1,5 +1,7 @@
 {{
 	include.content |
 	replace: '<table', '<div class="table-wrapper"><table' |
-	replace: '</table>', '</table></div>'
+	replace: '</table>', '</table></div>' |
+	replace: '<pre', '<div class="pre-wrapper"><pre' |
+	replace: '</pre>', '</pre></div>'
 }}

data/_layouts/print.html

@@ -0,0 +1,113 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		{% include internal/meta.html %}
+		
+		<title>{{ site.title | escape }}</title>
+		
+		{% if site.theme-settings.fontawesome.kit %}
+		<script src="{{ site.theme-settings.fontawesome.kit | uri_escape }}" crossorigin="anonymous"></script>
+		{% elsif site.theme-settings.fontawesome.local != true %}
+		<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.13.1/css/all.css" integrity="sha384-xxzQGERXS00kBmZW/6qxqJPyxW3UR0BPsL4c8ILaIWXva5kFi7TxkIIaMiKtqV1Q" crossorigin="anonymous">
+		{% endif %}
+		
+		{% include hooks/head-posthook.html %}
+	</head>
+	
+	<body class="print">
+		
+		<main>
+			
+			{% comment %}
+				
+				Loop through our chapters and their pages, building one large markdown string suitable for TOC generation.
+				We want this to all be a single string to ensure unique IDs are still generated even if there are headings with duplicate text.
+				
+				Note that we use HTML comments to inject our <section> and <article> tags, since the markdown processor will preserve the comments verbatim
+				and we can then strip them away to leave our HTML tags intact in the final output without being erroneously wrapped in <p> tags.
+				
+			{% endcomment %}
+			
+			{% assign markdown = "" %}
+			{% assign indices = site.documents | where: "collection", site.theme-settings.collection | where_exp: "page", "page.chapnum != null" | where_exp: "page", "page.pagenum == null" | sort: "chapnum" %}
+			{% if page.subsite %}
+				{% assign indices = indices | where: "subsite", page.subsite %}
+			{% endif %}
+			{% for index in indices %}
+				
+				{% assign pages = site.documents | where: "collection", site.theme-settings.collection | where: "chapnum", index.chapnum | where_exp: "page", "page.pagenum != null" | sort: "pagenum" %}
+				{% if page.subsite %}
+					{% assign pages = pages | where: "subsite", page.subsite %}
+				{% endif %}
+				
+{% capture content %}
+
+<!--[[<section class="chapter">]]-->
+
+# Chapter {{ index.chapnum }}: {{ index.chapter | escape }}
+
+{% assign description = index.content | strip %}{% if description.size > 0 %}{{ description }}{% endif %}
+
+<!--[[</section>]]-->
+
+{% for page in pages %}
+
+<!--[[<article class="page">]]-->
+
+# {{ page.title | escape }}
+
+{{ page.content }}
+
+<!--[[</article>]]-->
+
+{% endfor %}
+
+{% endcapture %}
+				
+				{% assign markdown = markdown | append: content %}
+				
+			{% endfor %}
+			
+			{% comment %}
+				
+				Render our generated markdown string and strip away the comment wrappers from our HTML tags.
+				
+			{% endcomment %}
+			{% assign rendered = markdown | markdownify | replace: "<!--[[", "" | replace: "]]-->", "" %}
+			
+			{% comment %}
+				
+				Output our book cover.
+				
+			{% endcomment %}
+			<section class="cover">
+				<h1>{{ site.title | escape }}</h1>
+			</section>
+			
+			{% comment %}
+				
+				Generate our Table of Contents (TOC) using the rendered markdown output and add a CSS class to chapter links.
+				
+			{% endcomment %}
+			<section class="toc">
+				<h1>Contents</h1>
+				{% capture toc %}{% include thirdparty/toc.html html=rendered sanitize=true %}{% endcapture %}
+				{{ toc | replace: '<li><a href="#chapter-', '<li class="chapter-link"><a href="#chapter-' }}
+			</section>
+			
+			{% comment %}
+				
+				Perform postprocessing on the rendered markdown output and print the result.
+				
+			{% endcomment %}
+			{% include internal/postprocessing.html content=rendered %}
+			
+		</main>
+		
+		<script src="{{ "/" | relative_url }}assets/js/thirdparty/jquery-3.4.1.min.js"></script>
+		<script src="{{ "/" | relative_url }}assets/js/thirdparty/popper.min.js"></script>
+		<script src="{{ "/" | relative_url }}assets/js/thirdparty/bootstrap.min.js"></script>
+		<script src="{{ "/" | relative_url }}assets/js/jekyll-theme-gitbook.js"></script>
+		{% include hooks/body-posthook.html %}
+	</body>
+</html>

data/_sass/_content.scss

@@ -236,12 +236,14 @@ article p + ul {
 	margin: 2rem 0;
 }
 
-article .table-wrapper
-{
-	margin: 2rem 0;
+article .pre-wrapper, article .table-wrapper {
 	overflow-x: auto;
 }
 
+article .table-wrapper {
+	margin: 2rem 0;
+}
+
 article table
 {
 	border-color: $default-border-colour;
@@ -314,6 +316,15 @@ article pre
 	word-wrap: break-word;
 }
 
+article pre code, article li pre code
+{
+	background-color: transparent;
+	padding: 0;
+	border-radius: 0;
+	display: inline;
+	margin: 0;
+}
+
 article pre, article pre code {
 	font-size: 0.95rem;
 }

data/_sass/_layout.scss

@@ -4,77 +4,81 @@
 	box-sizing: border-box;
 }
 
-html, body
-{
-	scroll-behavior: smooth;
-	min-height: 100%;
-}
-
-header
-{
-	display: flex;
-	flex-direction: row;
-	justify-content: space-between;
-	align-items: center;
+@media not print {
 	
-	padding: $header-padding 0;
-	height: $header-height;
-	position: fixed;
-	z-index: 999;
-	width: 100%;
-	top: 0;
-}
-
-.wrapper
-{
-	display: flex;
-	flex-direction: row;
-}
-
-nav, .contents {
-	flex: 0 0 auto;
-}
-
-nav .inner
-{
-	padding-top: $header-height / 2;
-	padding-left: $sidebar-padding / 2;
-	height: calc(100vh - #{$header-height});
+	html, body
+	{
+		scroll-behavior: smooth;
+		min-height: 100%;
+	}
+	
+	header
+	{
+		display: flex;
+		flex-direction: row;
+		justify-content: space-between;
+		align-items: center;
+		
+		padding: $header-padding 0;
+		height: $header-height;
+		position: fixed;
+		z-index: 999;
+		width: 100%;
+		top: 0;
+	}
+	
+	.wrapper
+	{
+		display: flex;
+		flex-direction: row;
+	}
+	
+	nav, .contents {
+		flex: 0 0 auto;
+	}
+	
+	nav .inner
+	{
+		padding-top: $header-height / 2;
+		padding-left: $sidebar-padding / 2;
+		height: calc(100vh - #{$header-height});
+		
+		overflow: hidden auto;
+		position: sticky;
+		top: $header-height;
+	}
+	
+	main
+	{
+		flex: 1;
+		display: flex;
+		flex-direction: row;
+		margin-top: $header-height;
+		padding: $header-height/2 0;
+	}
+	
+	.contents {
+		order: 2;
+	}
+	
+	.contents .inner
+	{
+		position: sticky;
+		top: $header-height * 1.5;
+	}
+	
+	.contents ul li a {
+		display: block;
+	}
+	
+	.contents-inline {
+		display: none;
+	}
+	
+	article
+	{
+		order: 1;
+		flex: 1;
+	}
 	
-	overflow: hidden auto;
-	position: sticky;
-	top: $header-height;
-}
-
-main
-{
-	flex: 1;
-	display: flex;
-	flex-direction: row;
-	margin-top: $header-height;
-	padding: $header-height/2 0;
-}
-
-.contents {
-	order: 2;
-}
-
-.contents .inner
-{
-	position: sticky;
-	top: $header-height * 1.5;
-}
-
-.contents ul li a {
-	display: block;
-}
-
-.contents-inline {
-	display: none;
-}
-
-article
-{
-	order: 1;
-	flex: 1;
 }

data/_sass/_print.scss

@@ -0,0 +1,52 @@
+@charset "UTF-8";
+
+.print main, .print main article
+{
+	display: block;
+	padding: 0;
+	margin: 0;
+}
+
+.print main article + article {
+	margin-top: 5rem;
+}
+
+.print section
+{
+	break-before: page;
+	break-after: page;
+}
+
+.print section:first-child, .print section + section {
+	break-before: initial;
+}
+
+.print .toc ul
+{
+	list-style-position: outside;
+	padding-left: 2.5rem;
+}
+
+.print .toc .chapter-link
+{
+	font-weight: 600;
+	list-style-type: none;
+	margin-bottom: 0.5rem;
+	margin-left: -2.5rem;
+}
+
+.print .toc li + .chapter-link {
+	margin-top: 1.5rem;
+}
+
+@media print
+{
+	.print .cover, .print .chapter
+	{
+		height: 100vh;
+		display: flex;
+		flex-direction: row;
+		justify-content: center;
+		align-items: center;
+	}
+}

data/_sass/_responsive.scss

@@ -130,7 +130,7 @@
 		padding: 0 1.5rem;
 	}
 	
-	article img, article figure, article .table-wrapper {
+	article img, article figure, article .pre-wrapper, article .table-wrapper {
 		max-width: calc((100vw - 3rem) - var(--scrollbar-width));
 	}
 	
@@ -165,7 +165,7 @@
 		padding: 0 $header-height;
 	}
 	
-	article img, article figure, article .table-wrapper {
+	article img, article figure, article .pre-wrapper, article .table-wrapper {
 		max-width: calc((100vw - #{$header-height * 2}) - var(--scrollbar-width));
 	}
 	

data/_sass/jekyll-theme-gitbook.scss

@@ -5,3 +5,4 @@
 @import 'layout';
 @import 'content';
 @import 'responsive';
+@import 'print';

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-gitbook
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Adam Rehn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2022-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,9 +90,11 @@ files:
 - _layouts/chapter-index.html
 - _layouts/chapter-redirect.html
 - _layouts/default.html
+- _layouts/print.html
 - _layouts/root-redirect.html
 - _sass/_content.scss
 - _sass/_layout.scss
+- _sass/_print.scss
 - _sass/_responsive.scss
 - _sass/_variables.scss
 - _sass/jekyll-theme-gitbook.scss
@@ -118,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.23
 signing_key: 
 specification_version: 4
 summary: Gem-based Jekyll theme for documentation sites, inspired by GitBook's visual