RubyGems - jekyll-theme-docgen - Versions diffs - 1.1.2 → 1.2.3 - Mend

jekyll-theme-docgen 1.1.2 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (87) hide show

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e29b75829d43dba846b8a9f3ff56e0eb0dd814578e895383d4d61fb326122223
-  data.tar.gz: 9439fd9810a3bdbd73c96e9395cb6cb1d83f0b15408aed3d39e8055b7c34df9e
+  metadata.gz: 7143df9bb7ca7a80f988de7c7004773171ae0448c24cb9a6e1ecf7ec8b6e109c
+  data.tar.gz: e3de2138f8d75cbda6e91c856eb44decacacfa6299f92547e8e7c61418311eb2
 SHA512:
-  metadata.gz: 2ce0908da296f714bf42f64a1efc1e4836464d3f4e4daf0de13f28435250617f9017ff00605ec41376af69b8d36224cfd0e27f498208b30a955e7becd175922a
-  data.tar.gz: 4e4aa04db9513daafd4a86c9881ab1d1c28ef06562ad454e699a9712cdfdb5c2cf3635d25bcc41642ba4887c456d9eb495f1537a047368359295355c6f24d656
+  metadata.gz: d3387331f92f4ff90e485c7d177eb87459588b28ad69f2f44493e2ee0fe532fdbc978e77f6cc0e40a2fba4583a748d7fa6c47619dc12678c4a87b4f2fd4f95ec
+  data.tar.gz: 5aa818ce88b21088d7815f33a1f940bca3662a73b6fe54edd657db51411727811dcc82dcc1a5064329e97d20b9385d875028cbe9158167f9a4f426f56bd2607a

data/README.md CHANGED

@@ -1,3 +1,50 @@
 # DocGen
 DocGen is a document generation helper built using Jekyll, as an alternative to
 LaTeX for the uninitiated. It is NOT for blogging.
+Uses MathJax for custom styles.
+### Examples
+See the `examples` folder for examples of how to use this theme.
+### Includes API
+- `{% include page-break-docgen %}` - Inserts a page break when printing, useful
+  when printing to PDF
+- `{% include break %}` - Shortcut for `{% include page-break-docgen %}`
+### CSS API
+Some of the available styles are easier to use without an `include`.
+- `pre.utf-box-drawing`, `code.utf-box-drawing` - Sets the font to "Source Code Pro",
+  which is compatible with the utf box drawing characters.
+- `div.page-break` - A page break.
+- `div.horizontal-line` - A container with a 1px black border top.
+- `div.display` - A `div` that follows flexbox wrapping rules.
+- `ol.heirarchical` - A list that supports the numbered-lettered-numeraled structure.
+### Layouts
+#### Documents
+- `default-docgen` - Base layout for docgen.
+- `latex-docgen` - Emulates a LaTeX document.
+- `mla-docgen` - Emulates an MLA-style document, i.e. 12pt Times New Roman with header.
+#### Utility Pages
+- `index-docgen` - Utility page that lists all documents.
+- `404-docgen` - Utility page for handling 404 errors.
+- `default` - shortcut for `default-docgen`.
+- `latex` - shortcut for `latex-docgen`.
+- `mla` - shortcut for `mla-docgen`.
+### Page & Site Properties
+- `lang` - Set the language in `_config.yml` or in the front matter
+- `mla` & `mla-docgen` - In the front matter, you can set:
+  - `author`
+  - `instructor`
+  - `course`
+  - `date`
+  All of which are copied verbatim. You can also set `title` in the front matter,
+  which is copied verbatim into own paragraph where the MLA standard says it should go.

data/_includes/break ADDED

	@@ -0,0 +1 @@
1	+ {% include page-break-docgen %}

data/_includes/head-docgen.html ADDED

@@ -0,0 +1,17 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>{{ page.title | default: 'docgen-document' }}</title>
+  <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js"
+    integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo"
+    crossorigin="anonymous" defer></script>
+  <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
+  {% assign style = include.style | default: 'default' %}
+  {% assign href ='/assets/docgen/css/' | append: style | append: '-style-docgen.css' | relative_url %}
+  <link rel="stylesheet" href="{{ href }}">
+  {% if include.content %}
+    {{ include.content }}
+  {% endif %}
+</head>

data/_includes/page-break-docgen ADDED

	@@ -0,0 +1 @@
1	+ <div class="page-break"></div>

data/_layouts/404-docgen.html ADDED

@@ -0,0 +1,39 @@
+---
+---
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: 'en' }}">
+  {% include head-docgen.html %}
+  <body>
+    <main class="page-content" aria-label="Content">
+      <h1>404 Not Found!</h1>
+      <p id="404-content">
+        The page couldn't be found :(
+        </br>
+        </br>
+        <a href="{{ '/' | relative_url }}">Click here to go back to the homepage</a>
+      </p>
+      {{ content }}
+    </main>
+    <!-- <script>
+      function sleep(ms) {
+        return new Promise(resolve => setTimeout(resolve, ms));
+      }
+      async function redirect() {
+        console.log(window.location.pathname);
+        if (window.location.pathname == '/') {
+          $('#404-content').text("You're being redirected to the correct homepage of this site...");
+          await sleep(1000);
+          window.location.replace('{{ '/' | relative_url }}');
+        }
+      }
+      redirect();
+    </script> -->
+  </body>
+</html>

data/_layouts/default-docgen.html ADDED

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: 'en' }}">
+  {% assign page-style = page.layout | downcase | split: '-' | first %}
+  {% include head-docgen.html style=page-style %}
+  <body>
+    <main class="page-content" aria-label="Content">
+      {{ content }}
+      <script src='https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-MML-AM_CHTML' async></script>
+    </main>
+  </body>
+</html>

data/_layouts/default.html CHANGED

@@ -1,15 +1,4 @@
-<!DOCTYPE html>
-<html lang="{{ page.lang | default: site.lang | default: 'en' }}">
-  {% assign page-style = page.layout | downcase %}
-  {% include head.html style=page-style %}
-  <body>
-    <main class="page-content" aria-label="Content">
-        {{ content }}
-    </main>
-  </body>
-</html>
+---
+layout: default-docgen
+---
+{{ content }}

data/_layouts/index-docgen.html ADDED

@@ -0,0 +1,46 @@
+---
+---
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: 'en' }}">
+  {% include head-docgen.html %}
+  <body>
+    <main class="page-content" aria-label="Content">
+      <h1>Pages</h1>
+      {% assign sorted-pages = site.pages | sort: "path" %}
+      {% for page in sorted-pages %}
+        {% assign file-name = page.path | split: '/' | last %}
+        {% unless file-name contains 'scss' %}
+          <a href="{{ page.url | relative_url }}">{{ page.path }}</a><br/>
+        {% endunless %}
+      {% endfor %}
+      <br class="clearfix" />
+      {% assign sorted-static-files = site.static_files | sort: "path" %}
+      {% assign static-files = '' | split: '' %}
+      {% for file in sorted-static-files %}
+        {% assign file-name = file.path | split: '/' %}
+        {% assign file-path = file.path | append: ':' | split:  ':' %}
+        {% unless file-name[1] == 'assets' and file-name[2] == 'docgen' %}
+          {% assign static-files = static-files | concat: file-path %}
+        {% endunless %}
+      {% endfor %}
+      {% if static-files.size > 0 %}
+        <h1>Static Files</h1>
+        {% for file-path in static-files %}
+          <a href="{{ file-path | relative_url }}">{{ file-path }}</a><br/>
+        {% endfor %}
+      {% endif %}
+      <br class="clearfix" />
+      {{ content }}
+    </main>
+  </body>
+</html>

data/_layouts/latex-docgen.html ADDED

@@ -0,0 +1,4 @@
+---
+layout: default-docgen
+---
+{{ content }}

data/_layouts/latex.html CHANGED

@@ -1,4 +1,4 @@
 ---
-layout: default
+layout: latex-docgen
 ---
-{{ content }}
+{{ content }}

data/_layouts/mla-docgen.html ADDED

@@ -0,0 +1,30 @@
+---
+layout: default-docgen
+---
+{% if page.header %}
+<p class="noindent">
+  {% for line in page.header %}
+    {{ line }}
+    <br />
+  {% endfor %}
+</p>
+{% elsif page.author or page.date or page.instructor or page.course %}
+<p class="noindent">
+  {{ page.author }}
+  <br />
+  {{ page.instructor }}
+  <br />
+  {{ page.course }}
+  <br />
+  {{ page.date }}
+  <br />
+</p>
+{% endif %}
+{% assign title = page.title | default: '' | strip %}
+{% unless title == '' %}
+<p class="mla-title">
+{{ title }}
+</p>
+{% endunless %}
+{{ content }}

data/_layouts/mla.html CHANGED

@@ -1,4 +1,4 @@
 ---
-layout: default
+layout: mla-docgen
 ---
-{{ content }}
+{{ content }}

data/_sass/{docgen-default.scss → docgen/default-docgen.scss} RENAMED

@@ -12,7 +12,7 @@ $spacing-unit:     30px !default;
 $text-color:       #111 !default;
 $background-color: #fdfdfd !default;
-$brand-color:      #2a7ae2 !default;
+$link-color:      #2a7ae2 !default;
 $grey-color:       #828282 !default;
 $grey-color-light: lighten($grey-color, 40%) !default;
@@ -24,6 +24,7 @@ $blockquote-border-color: $grey-color-light !default;
 $table-border-color: $grey-color-light !default;
+$code-font-family: "Source Code Pro", "Consolas", "Monaco", "Lucida Console", "Liberation Mono", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Courier New" !default;
 $code-text-color: $text-color !default;
 $code-block-border-color: $grey-color-light !default;
 $code-block-background-color: #eef !default;
@@ -33,6 +34,7 @@ $syntax-highlighting-background-color: #fff !default;
 $content-width: 800px !default;
 @import
+  "fonts/source-code-pro",
   "docgen/utils",
   "docgen/syntax-highlighting",
   "docgen/base",

data/_sass/docgen/docgen/_api.scss ADDED

@@ -0,0 +1,76 @@
+// @media print {
+//   hr, div.horizontal-line {
+//     // -webkit-print-color-adjust: exact;
+//   }
+// }
+%horizontal-line {
+  margin-top: $spacing-unit;
+  margin-bottom: $spacing-unit;
+  border-top: 1px solid black;
+}
+hr, div.horizontal-line, div.page-break {
+  @extend %horizontal-line;
+}
+div.page-break {
+  break-after: page;
+}
+@media print {
+  div.page-break {
+    height: 0px;
+    border-top: none;
+  }
+}
+div.display {
+  display: -webkit-box;
+  display: -moz-box;
+  display: -ms-flexbox;
+  display: -webkit-flex;
+  display: flex;
+  flex-wrap: wrap;
+  padding-left: auto;
+  padding-right: auto;
+  width: 100%;
+  margin: 0px;
+  &.center {
+    align-items: center;
+    justify-content: center;
+  }
+  > * {
+    margin-left: $spacing-unit / 4;
+    margin-right: $spacing-unit / 4;
+  }
+}
+// https://developer.mozilla.org/en-US/docs/Web/CSS/list-style-type#Syntax
+ol.heirarchical > li {
+  ol, ul {
+    //margin-bottom: 0px;
+  }
+  > ol > li {
+    list-style-type: lower-alpha;
+    > ol > li {
+      list-style-type: lower-roman;
+    }
+  }
+}
+// .citation-docgen {
+//   .citation-number-docgen:after {
+//     counter-increment: citation-docgen;
+//     content: counter(citation-docgen);
+//   }
+// }
+pre.utf-box-drawing,
+code.utf-box-drawing {
+  font-family: "Source Code Pro";
+}

data/_sass/docgen/{_base.scss → docgen/_base.scss} RENAMED

@@ -37,11 +37,11 @@ ul, ol {
   padding: 0px;
 }
-main > {
-  ul, ol {
-    margin-left: 0px;
-  }
-}
+// main > {
+//   ul, ol {
+//     margin-left: 0px;
+//   }
+// }
 li > {
   ul, ol {
@@ -49,6 +49,8 @@ li > {
   }
 }
 /**
  * Headings
  */
@@ -62,11 +64,11 @@ h1, h2, h3, h4, h5, h6 {
  * Links
  */
 a {
-  color: $brand-color;
+  color: $link-color;
   text-decoration: none;
   &:visited {
-    color: darken($brand-color, 15%);
+    color: darken($link-color, 15%);
   }
   &:hover {
@@ -76,6 +78,7 @@ a {
 }
 /**
  * Blockquotes
  */
@@ -99,6 +102,7 @@ blockquote {
  */
 pre,
 code {
+  font-family: $code-font-family;
   @include relative-font-size(0.9375);
 }
@@ -108,6 +112,7 @@ code {
 pre {
   border: 1px solid $code-block-border-color;
+  line-height: 1.3;
   border-radius: 3px;
   padding: 8px 12px;
   overflow-x: auto;
@@ -119,3 +124,24 @@ pre {
     padding-left: 0;
   }
 }
+/**
+ * Tables
+ */
+th, td {
+  padding: $spacing-unit / 4;
+  border: 1px solid black;
+  border-collapse: collapse;
+}
+.error-docgen {
+  border: 5px solid red;
+  color: white !important;
+  font-weight: bold;
+  min-width: 100%;
+  background: red;
+}