dendron-jekyll 0.3.2 → 0.3.7

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 95bc4ff3c20422b2d1447d13603aa10db06551aa9bd7a7a4f089636c745536a0
4
- data.tar.gz: acad865bfc5b3a2b76601cecc7b85c725f0db97b90ebfdaf4f3fb3814363c9db
3
+ metadata.gz: 179dab9eca45698050d57fe443c0fed1ae42388138d69a80f224aa65bce552fc
4
+ data.tar.gz: 2c09ab175cd91f107bd0e770c8191fc534c7fc6ec4f91281e3e0d60755f66233
5
5
  SHA512:
6
- metadata.gz: 15d5c378447f9d9b6f77f1e2d0ee71a67e28aee414e9f458ccbc57f8f4cd598a79b955fc584fa11515d53cb484515ac5db8bcf37fc0c0db20b15681dbe3df3de
7
- data.tar.gz: 8162d57b4c2f2d683507e6a5189c0b4dd7ef5d6f5772c95f7590b520a0dbd89522c262d03ee35824f625d8aac825622a46b86eb2a128556d804b96ab57a60810
6
+ metadata.gz: 5438a789546185ef3faf861c102a63849388fffe1dbf1e597c9e6212008ce3219dbd67d274c83e4ff85e5d7a0a95d2199665c075de2f52a8645faeca4849ba1b
7
+ data.tar.gz: a4cdcd5e3a38d0db7a5b7d163df7cb8cd3e28c8b324e13b237cff22fbd29fa045a543ad61bb2f4e3dcfe87f14ba90b64c5d310d876caf2e5176f25901e37926c
data/README.md CHANGED
@@ -1,28 +1,30 @@
1
- <p align="right">
2
- <a href="https://badge.fury.io/rb/just-the-docs"><img src="https://badge.fury.io/rb/just-the-docs.svg" alt="Gem version"></a> <a href="https://github.com/pmarsceill/just-the-docs/actions?query=workflow%3A%22Master+branch+CI%22"><img src="https://github.com/pmarsceill/just-the-docs/workflows/Master%20branch%20CI/badge.svg" alt="Build status"></a>
3
- </p>
4
- <br><br>
5
1
  <p align="center">
6
- <h1 align="center">Just the Docs</h1>
7
- <p align="center">A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.<br>Easily hosted on GitHub Pages with few dependencies.</p>
2
+ <h1 align="center">Dendron Jekyll</h1>
3
+ </p>
4
+
5
+ This is the Jekyll theme used by Dendron. It is a fork of [just-the-docs](https://pmarsceill.github.io/just-the-docs/) theme with custom changes to allow for deep hierarchies, lookups and unique ids. It also borrows many elements from the [minimal mistakes](https://mmistakes.github.io/minimal-mistakes/).
6
+
7
+ <!--
8
+ <!-- <p align="center">A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.<br>Easily hosted on GitHub Pages with few dependencies.</p>
8
9
  <p align="center"><strong><a href="https://pmarsceill.github.io/just-the-docs/">See it in action!</a></strong></p>
9
10
  <br><br><br>
10
- </p>
11
+ </p> -->
12
+
13
+ ![dendron-jekyll](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-lookup.gif)
11
14
 
12
- ![jtd](https://user-images.githubusercontent.com/896475/47384541-89053c80-d6d5-11e8-98dc-dba16e192de9.gif)
13
15
 
14
16
  ## Installation
15
17
 
16
18
  Add this line to your Jekyll site's Gemfile:
17
19
 
18
20
  ```ruby
19
- gem "just-the-docs"
21
+ gem "dendron-jekyll"
20
22
  ```
21
23
 
22
24
  And add this line to your Jekyll site's `_config.yml`:
23
25
 
24
26
  ```yaml
25
- theme: just-the-docs
27
+ theme: dendron-jekyll
26
28
  ```
27
29
 
28
30
  And then execute:
@@ -31,7 +33,7 @@ And then execute:
31
33
 
32
34
  Or install it yourself as:
33
35
 
34
- $ gem install just-the-docs
36
+ $ gem install dendron-jekyll
35
37
 
36
38
  ## Usage
37
39
 
@@ -33,8 +33,13 @@
33
33
 
34
34
  <meta name="viewport" content="width=device-width, initial-scale=1">
35
35
 
36
+ {% if page.noindex %}
37
+ <meta name="robots" content="noindex, nofollow">
38
+ {% endif %}
39
+
40
+
36
41
  {% seo %}
37
42
 
38
43
  {% include head_custom.html %}
39
44
 
40
- </head>
45
+ </head>
@@ -17,9 +17,12 @@
17
17
  {%- for node in pages_list -%}
18
18
  {%- include active.html node=node -%}
19
19
  <li class="nav-list-item{% if active %} active{% endif %}">
20
+ {%- if node.children.size > 0 and node.permalink != '/' -%}
21
+ {%- unless node.expand_exclude -%}
22
+ <a href="" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
23
+ {%- endunless -%}
24
+ {%- endif -%}
20
25
  <a href="{{ node.url | absolute_url }}" class="nav-list-link{% if active %} active{% endif %}">{{ node.title }}</a>
21
-
22
- {%- if active -%}
23
26
  {%- assign active = false -%}
24
27
  {%- assign children = hierarchy | where_exp:"item", "item.name == node.id" | map: "items" | first -%}
25
28
  {%- if children -%}
@@ -28,7 +31,6 @@
28
31
  {%- include nav.html nodes=children -%}
29
32
  {%- endif -%}
30
33
  {%- endif -%}
31
- {%- endif -%}
32
34
  </li>
33
35
  {%- endfor -%}
34
36
 
@@ -2,8 +2,9 @@
2
2
  {%- if tocNodes.size > 0 -%}
3
3
  <hr>
4
4
  <h2 class="text-delta">Table of contents</h2>
5
+ {%- assign sorted_nodes = tocNodes | sort_natural:"title" -%}
5
6
  <ul>
6
- {%- for tocNode in tocNodes -%}
7
+ {%- for tocNode in sorted_nodes -%}
7
8
  <li>
8
9
  <a href="{{ tocNode.url | absolute_url }}">{{ tocNode.title }}</a>
9
10
  {%- if tocNode.summary -%}
@@ -97,6 +97,20 @@ layout: table_wrappers
97
97
  {% endif %}
98
98
  {% endunless %}
99
99
  <div id="main-content" class="main-content" role="main">
100
+
101
+ {% if page.source %}
102
+ <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css" integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk" crossorigin="anonymous">
103
+ <script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
104
+ <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
105
+ <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
106
+
107
+ <div class="alert alert-primary" role="alert">
108
+ This material on this page is derived from content first created on <a href="{{page.source.url}}" target="_blank">{% if page.source.name %} {{page.source.name}} {% else %} {{page.source.url}} {% endif %}
109
+ </a>
110
+ </div>
111
+
112
+ {% endif %}
113
+
100
114
  {% if site.heading_anchors != false %}
101
115
  {% include vendor/anchor_headings.html html=content beforeHeading="true" anchorBody="<svg viewBox=\"0 0 16 16\" aria-hidden=\"true\"><use xlink:href=\"#svg-link\"></use></svg>" anchorClass="anchor-heading" %}
102
116
  {% else %}
@@ -135,7 +149,7 @@ layout: table_wrappers
135
149
  site.gh_edit_view_mode
136
150
  %}
137
151
  <p class="text-small text-grey-dk-000 mb-0">
138
- <a href="{{ site.gh_edit_repository }}/{{ site.gh_edit_view_mode }}/{{ site.gh_edit_branch }}/{{ page.path }}" id="edit-this-page">{{ site.gh_edit_link_text }}</a>
152
+ <a href="{{ site.gh_edit_repository }}/{{ site.gh_edit_view_mode }}/{{ site.gh_edit_branch }}/{{ site.dendron_vault_path }}/{{ page.fname }}.md" id="edit-this-page">{{ site.gh_edit_link_text }}</a>
139
153
  </p>
140
154
  {% endif %}
141
155
  </div>
@@ -0,0 +1,114 @@
1
+ // Clear normal iframe styles
2
+ iframe{
3
+ border: none;
4
+ }
5
+
6
+ // Portal styles
7
+ .portal-container{
8
+ overscroll-behavior: contain;
9
+ border: 1px solid #C2DFE3;
10
+ border-radius: 8px;
11
+ margin-bottom: 24px;
12
+ padding: 10px;
13
+
14
+ -webkit-transition: all .20s ease;
15
+ -moz-transition: all .20s ease;
16
+ -ms-transition: all .20s ease;
17
+ -o-transition: all .20s ease;
18
+ transition: all .20s ease;
19
+
20
+ &:hover{
21
+ transform: translateY(-3px);
22
+ box-shadow: 0px 6px 20px 0px rgba(0,0,0,.15);
23
+ border: 1px solid #9DB8BF;
24
+ }
25
+
26
+ .portal-head{
27
+ border-bottom: 1px solid #C2DFE3;
28
+ padding: 12px;
29
+
30
+ .portal-backlink{
31
+ display: flex;
32
+ flex-direction: column;
33
+
34
+ -webkit-transition: all .20s ease;
35
+ -moz-transition: all .20s ease;
36
+ -ms-transition: all .20s ease;
37
+ -o-transition: all .20s ease;
38
+ transition: all .20s ease;
39
+ // @include align-items($align: left);
40
+
41
+ @media(min-width:600px){
42
+ flex-direction: row;
43
+ justify-content: space-between;
44
+ align-items: center;
45
+ }
46
+ .portal-title{
47
+ font-size: 14px;
48
+ color: #9DB8BF;
49
+ .portal-text-title{
50
+ font-weight:700;
51
+ color: #5C6D73;
52
+ }
53
+ }
54
+ .portal-arrow{
55
+ font-size: 14px;
56
+ color: #9DB8BF;
57
+ &:hover{
58
+ opacity:.5;
59
+ }
60
+ }
61
+ }
62
+ }
63
+
64
+ .portal-iframe{
65
+ overflow:hidden;
66
+ }
67
+ .portal-parent{
68
+ overflow:hidden;
69
+ position: relative;
70
+ width:100%;
71
+ box-sizing: border-box;
72
+ .portal-parent-fader-top{
73
+ position: absolute;
74
+ width: 100%;
75
+ margin-left: 0px;
76
+ height: 36px;
77
+ // background-image: linear-gradient(rgba(255,255,255,1), rgba(255,255,255,0));
78
+ z-index: 50;
79
+ }
80
+ .portal-parent-fader-bottom{
81
+ position: absolute;
82
+ width: 100%;
83
+ bottom: 6px;
84
+ margin-left: 0px;
85
+ height: 36px;
86
+ // background-image: linear-gradient(rgba(255,255,255,0), rgba(255,255,255,1));
87
+ z-index: 50;
88
+ }
89
+ .portal-parent-text{
90
+ padding:$base-line-height / 2;
91
+ color: #5C6D73;
92
+ z-index: 40;
93
+ }
94
+ .portal-iframe{
95
+ width:100%;
96
+ height:400px;
97
+ }
98
+ }
99
+ }
100
+
101
+ // Things that happen in the iframe have to be applied to the whole site,
102
+ // as you can't use css on iframe contents – not a major issue for the time being,
103
+ // considering you have to own the site you're transcluding.
104
+ // Make sure your theme's anchor text styling explicitly hits a:link and not all a tags to avoid
105
+ // making quoted text look like a link.
106
+ .portal-quote-text {
107
+ background-color: #C2DFE3;
108
+ color: lighten($text-color, 15%);
109
+
110
+ // This fixes hovers behaving wrong on safari when using an <a> tag to highlight
111
+ &:hover {
112
+ text-decoration: none;
113
+ }
114
+ }
@@ -19,7 +19,14 @@
19
19
  @import "./utilities/utilities";
20
20
  @import "./print";
21
21
 
22
+ // Portal Start
23
+ $base-line-height: 1.5 !default;
24
+ $spacing-unit: 30px !default;
25
+ $text-color: #111 !default;
26
+ // Portal end
27
+
22
28
  @import "minimal-mistakes/variables";
23
29
  @import "minimal-mistakes/vendor/breakpoint/breakpoint";
24
30
  @import "minimal-mistakes/mixins";
25
- @import "minimal-mistakes/sidebar";
31
+ @import "minimal-mistakes/sidebar";
32
+ @import "portal.scss";
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: dendron-jekyll
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.2
4
+ version: 0.3.7
5
5
  platform: ruby
6
6
  authors:
7
7
  - Kevin Lin
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-08-06 00:00:00.000000000 Z
11
+ date: 2020-09-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -72,7 +72,7 @@ dependencies:
72
72
  - - "<"
73
73
  - !ruby/object:Gem::Version
74
74
  version: 13.1.0
75
- description:
75
+ description:
76
76
  email:
77
77
  - kevin@thence.io
78
78
  executables:
@@ -109,6 +109,7 @@ files:
109
109
  - _layouts/single.html
110
110
  - _layouts/table_wrappers.html
111
111
  - _layouts/vendor/compress.html
112
+ - _sass/_portal.scss
112
113
  - _sass/base.scss
113
114
  - _sass/buttons.scss
114
115
  - _sass/code.scss
@@ -223,7 +224,7 @@ homepage: https://github.com/dendronhq/dendron-jekyll
223
224
  licenses:
224
225
  - MIT
225
226
  metadata: {}
226
- post_install_message:
227
+ post_install_message:
227
228
  rdoc_options: []
228
229
  require_paths:
229
230
  - lib
@@ -239,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
239
240
  version: '0'
240
241
  requirements: []
241
242
  rubygems_version: 3.0.3
242
- signing_key:
243
+ signing_key:
243
244
  specification_version: 4
244
245
  summary: Dendron Jekyll Theme
245
246
  test_files: []