jekyll-theme-docgen 1.1.3 → 1.2.0

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 (18) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +42 -0
  3. data/_includes/break +1 -0
  4. data/_includes/{head.html → head-docgen.html} +0 -0
  5. data/_includes/page-break-docgen +1 -0
  6. data/_layouts/404-docgen.html +7 -4
  7. data/_layouts/default-docgen.html +1 -1
  8. data/_layouts/index-docgen.html +1 -1
  9. data/_sass/default-docgen.scss +3 -3
  10. data/_sass/docgen/_api.scss +6 -13
  11. data/_sass/docgen/_base.scss +2 -2
  12. data/_sass/fonts/computer-modern.scss +20 -0
  13. data/_sass/{docgen → fonts}/source-code-pro.scss +0 -0
  14. data/_sass/latex-docgen.scss +1 -21
  15. metadata +7 -7
  16. data/_includes/citation +0 -12
  17. data/_includes/citation-data +0 -10
  18. data/assets/.DS_Store +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 4d2500b2e2297973d8881af902d08a7bb12c8eb5
4
- data.tar.gz: e04d351567e9b55f549ea7551cfe49dea8bdbbc4
3
+ metadata.gz: ff1b8ec7882999b545f7f8fb64ef7c35e2554a99
4
+ data.tar.gz: b7a46d7fb4588d5ac7371f6411ef459ef0e19b19
5
5
  SHA512:
6
- metadata.gz: db55bd50b78b0ba892f499197a6268ba8fa58bd4eab9317a46faefd323db65ee9ebe5732ed7b54da09333779978bc13d9d1b03d234f481ee9b3395caea52da5b
7
- data.tar.gz: 38759ebc7c934a6ea95bf9674c192d53174ccae4caf0569f600e26c964ef15b7ca789b712567013bbc1e5d5af0eb94693d05dd3b4704e492a2fb7dd015e27f3c
6
+ metadata.gz: 7dab071bb0aabcd8050fba51564d1c598187643a6f67e3985751a012aaafc50893b6f887155bd36dd444912799bf020e928c950f886a50c06a93019ff2866546
7
+ data.tar.gz: a4ce57059e6ff7f979985b5c0671155e52605c3a6db5b9325cc42ee9f7744b3501c16bc412ee9fb22a6a4df2ff108b428f1c08bbb19366d0df11356e20059157
data/README.md CHANGED
@@ -1,3 +1,45 @@
1
1
  # DocGen
2
2
  DocGen is a document generation helper built using Jekyll, as an alternative to
3
3
  LaTeX for the uninitiated. It is NOT for blogging.
4
+
5
+ Uses MathJax for custom styles.
6
+
7
+ ### Includes API
8
+ - `{% include page-break-docgen %}` - Inserts a page break when printing, useful
9
+ when printing to PDF
10
+ - `{% include break %}` - Shortcut for `{% include page-break-docgen %}`
11
+
12
+
13
+ ### CSS API
14
+ Some of the available styles are easier to use without an `include`.
15
+
16
+ - `div.page-break` - A page break.
17
+ - `div.display` - A `div` that follows flexbox wrapping rules.
18
+ - `ol.heirarchical` - A list that supports the numbered-lettered-numeraled structure.
19
+
20
+ ### Layouts
21
+
22
+ #### Documents
23
+ - `default-docgen` - Base layout for docgen.
24
+ - `latex-docgen` - Emulates a LaTeX document.
25
+ - `mla-docgen` - Emulates an MLA-style document, i.e. 12pt Times New Roman with header.
26
+
27
+ #### Utility Pages
28
+ - `index-docgen` - Utility page that lists all documents.
29
+ - `404-docgen` - Utility page for handling 404 errors.
30
+ - `default` - shortcut for `default-docgen`.
31
+ - `latex` - shortcut for `latex-docgen`.
32
+ - `mla` - shortcut for `mla-docgen`.
33
+
34
+ ### Page & Site Properties
35
+ - `lang` - Set the language in `_config.yml` or in the front matter
36
+ - `mla` & `mla-docgen` - In the front matter, you can set:
37
+
38
+ - `author`
39
+ - `instructor`
40
+ - `course`
41
+ - `date`
42
+
43
+ All of which are copied verbatim. You can also set `title` in the front matter,
44
+ which is copied verbatim into own paragraph where the MLA standard says it should go.
45
+
data/_includes/break ADDED
@@ -0,0 +1 @@
1
+ {% include page-break-docgen %}
data/_includes/{head.html → head-docgen.html} RENAMED
File without changes
data/_includes/page-break-docgen ADDED
@@ -0,0 +1 @@
1
+ <div class="page-break"></div>
data/_layouts/404-docgen.html CHANGED
@@ -3,7 +3,7 @@
3
3
  <!DOCTYPE html>
4
4
  <html lang="{{ site.lang | default: 'en' }}">
5
5
 
6
- {% include head.html %}
6
+ {% include head-docgen.html %}
7
7
 
8
8
  <body>
9
9
 
@@ -11,11 +11,14 @@
11
11
  <h1>404 Not Found!</h1>
12
12
  <p id="404-content">
13
13
  The page couldn't be found :(
14
+ </br>
15
+ </br>
16
+ <a href="{{ '/' | relative_url }}">Click here to go back to the homepage</a>
14
17
  </p>
15
18
  {{ content }}
16
19
  </main>
17
20
 
18
- <script>
21
+ <!-- <script>
19
22
  function sleep(ms) {
20
23
  return new Promise(resolve => setTimeout(resolve, ms));
21
24
  }
@@ -25,12 +28,12 @@
25
28
  if (window.location.pathname == '/') {
26
29
  $('#404-content').text("You're being redirected to the correct homepage of this site...");
27
30
  await sleep(1000);
28
- window.location.replace({{ '/' | relative_url }});
31
+ window.location.replace('{{ '/' | relative_url }}');
29
32
  }
30
33
  }
31
34
 
32
35
  redirect();
33
- </script>
36
+ </script> -->
34
37
  </body>
35
38
 
36
39
  </html>
data/_layouts/default-docgen.html CHANGED
@@ -2,7 +2,7 @@
2
2
  <html lang="{{ page.lang | default: site.lang | default: 'en' }}">
3
3
 
4
4
  {% assign page-style = page.layout | downcase | split: '-' | first %}
5
- {% include head.html style=page-style %}
5
+ {% include head-docgen.html style=page-style %}
6
6
 
7
7
  <body>
8
8
  <main class="page-content" aria-label="Content">
data/_layouts/index-docgen.html CHANGED
@@ -3,7 +3,7 @@
3
3
  <!DOCTYPE html>
4
4
  <html lang="{{ site.lang | default: 'en' }}">
5
5
 
6
- {% include head.html %}
6
+ {% include head-docgen.html %}
7
7
 
8
8
  <body>
9
9
 
data/_sass/default-docgen.scss CHANGED
@@ -12,7 +12,7 @@ $spacing-unit: 30px !default;
12
12
 
13
13
  $text-color: #111 !default;
14
14
  $background-color: #fdfdfd !default;
15
- $brand-color: #2a7ae2 !default;
15
+ $link-color: #2a7ae2 !default;
16
16
 
17
17
  $grey-color: #828282 !default;
18
18
  $grey-color-light: lighten($grey-color, 40%) !default;
@@ -24,7 +24,7 @@ $blockquote-border-color: $grey-color-light !default;
24
24
 
25
25
  $table-border-color: $grey-color-light !default;
26
26
 
27
- $code-font-family: "Consolas", "Monaco", "Lucida Console", "Liberation Mono", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Courier New" !default;
27
+ $code-font-family: "Source Code Pro", "Consolas", "Monaco", "Lucida Console", "Liberation Mono", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Courier New" !default;
28
28
  $code-text-color: $text-color !default;
29
29
  $code-block-border-color: $grey-color-light !default;
30
30
  $code-block-background-color: #eef !default;
@@ -34,7 +34,7 @@ $syntax-highlighting-background-color: #fff !default;
34
34
  $content-width: 800px !default;
35
35
 
36
36
  @import
37
- "docgen/source-code-pro",
37
+ "fonts/source-code-pro",
38
38
  "docgen/utils",
39
39
  "docgen/syntax-highlighting",
40
40
  "docgen/base",
data/_sass/docgen/_api.scss CHANGED
@@ -29,13 +29,6 @@ div.display {
29
29
  }
30
30
  }
31
31
 
32
- div.utf-box-drawing {
33
- pre, > pre, pre code {
34
- font-family: "Source Code Pro";
35
- line-height: initial;
36
- }
37
- }
38
-
39
32
 
40
33
  // https://developer.mozilla.org/en-US/docs/Web/CSS/list-style-type#Syntax
41
34
  ol.heirarchical > li {
@@ -51,12 +44,12 @@ ol.heirarchical > li {
51
44
  }
52
45
  }
53
46
 
54
- .citation-docgen {
55
- .citation-number-docgen:after {
56
- counter-increment: citation-docgen;
57
- content: counter(citation-docgen);
58
- }
59
- }
47
+ // .citation-docgen {
48
+ // .citation-number-docgen:after {
49
+ // counter-increment: citation-docgen;
50
+ // content: counter(citation-docgen);
51
+ // }
52
+ // }
60
53
 
61
54
  @media print {
62
55
  .page-break {
data/_sass/docgen/_base.scss CHANGED
@@ -64,11 +64,11 @@ h1, h2, h3, h4, h5, h6 {
64
64
  * Links
65
65
  */
66
66
  a {
67
- color: $brand-color;
67
+ color: $link-color;
68
68
  text-decoration: none;
69
69
 
70
70
  &:visited {
71
- color: darken($brand-color, 15%);
71
+ color: darken($link-color, 15%);
72
72
  }
73
73
 
74
74
  &:hover {
data/_sass/fonts/computer-modern.scss ADDED
@@ -0,0 +1,20 @@
1
+ @font-face { // Declaring font faces for LaTeX font
2
+ font-family: "Computer Modern";
3
+ src: url('../fonts/computer-modern/cmunrm.ttf');
4
+ }
5
+ @font-face {
6
+ font-family: "Computer Modern";
7
+ src: url('../fonts/computer-modern/cmunbx.ttf');
8
+ font-weight: bold;
9
+ }
10
+ @font-face {
11
+ font-family: "Computer Modern";
12
+ src: url('../fonts/computer-modern/cmunti.ttf');
13
+ font-style: italic;
14
+ }
15
+
16
+ @font-face {
17
+ font-family: "Computer Modern Typewriter";
18
+ src: url('../fonts/computer-modern/cmuntb.ttf');
19
+ }
20
+
data/_sass/{docgen → fonts}/source-code-pro.scss RENAMED
File without changes
data/_sass/latex-docgen.scss CHANGED
@@ -1,28 +1,8 @@
1
- @font-face { // Declaring font faces for LaTeX font
2
- font-family: "Computer Modern";
3
- src: url('../fonts/computer-modern/cmunrm.ttf');
4
- }
5
- @font-face {
6
- font-family: "Computer Modern";
7
- src: url('../fonts/computer-modern/cmunbx.ttf');
8
- font-weight: bold;
9
- }
10
- @font-face {
11
- font-family: "Computer Modern";
12
- src: url('../fonts/computer-modern/cmunti.ttf');
13
- font-style: italic;
14
- }
15
-
16
- @font-face {
17
- font-family: "Computer Modern Typewriter";
18
- src: url('../fonts/computer-modern/cmuntb.ttf');
19
- }
20
-
21
1
  $base-font-family: "Computer Modern", sans-serif;
22
2
  $code-font-family: "Computer Modern Typewriter", Consolas, Monaco;
23
3
  $code-block-background-color: white !default;
24
4
  $syntax-highlighting-background-color: white !default;
25
- @import "default-docgen";
5
+ @import "fonts/computer-modern", "default-docgen";
26
6
 
27
7
  // Set page margins for printer
28
8
  @page {
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-docgen
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.3
4
+ version: 1.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Albert Liu
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-06-01 00:00:00.000000000 Z
11
+ date: 2019-10-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -33,9 +33,9 @@ extra_rdoc_files: []
33
33
  files:
34
34
  - LICENSE
35
35
  - README.md
36
- - _includes/citation
37
- - _includes/citation-data
38
- - _includes/head.html
36
+ - _includes/break
37
+ - _includes/head-docgen.html
38
+ - _includes/page-break-docgen
39
39
  - _layouts/404-docgen.html
40
40
  - _layouts/default-docgen.html
41
41
  - _layouts/default.html
@@ -52,11 +52,11 @@ files:
52
52
  - _sass/docgen/_layout.scss
53
53
  - _sass/docgen/_syntax-highlighting.scss
54
54
  - _sass/docgen/_utils.scss
55
- - _sass/docgen/source-code-pro.scss
55
+ - _sass/fonts/computer-modern.scss
56
+ - _sass/fonts/source-code-pro.scss
56
57
  - _sass/latex-docgen.scss
57
58
  - _sass/mla-docgen.scss
58
59
  - _sass/slides-docgen.scss
59
- - assets/.DS_Store
60
60
  - assets/css/default-style-docgen.scss
61
61
  - assets/css/latex-style-docgen.scss
62
62
  - assets/css/mla-style-docgen.scss
data/_includes/citation DELETED
@@ -1,12 +0,0 @@
1
- {% capture text %}
2
- {% if include.local %}
3
- {% assign link = include.local | prepend: '#' | append: '-docgen' %}
4
- {% elsif include.link %}
5
- {% assign link = include.link %}
6
- {% endif %}
7
- {% if link %}
8
- <sup class="citation-docgen">[<a href="{{ link }}"><span class="citation-number-docgen"></span></a>]</sup>
9
- {% else %}
10
- <sup class="citation-docgen">[<span class="citation-number-docgen"></span>]</sup>
11
- {% endif %}
12
- {% endcapture %}{{- text | strip | strip_newlines -}}
data/_includes/citation-data DELETED
@@ -1,10 +0,0 @@
1
- {% capture text %}
2
- {% if include.id %}
3
- <a
4
- id="{{ include.id | append: '-docgen' }}"
5
- name="{{ include.id | append: '-docgen' }}"></a>
6
- {% elsif site.docgen.error %}
7
- <a class="error-docgen">DocGen Error:
8
- {% raw %}{% include citation-data %} needs parameter 'id'{% endraw %}</a>
9
- {% endif %}
10
- {% endcapture %}{{- text | strip -}}
data/assets/.DS_Store DELETED
Binary file