jekyll-graph 0.0.1 → 0.0.2
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/README.md +8 -3
- data/lib/jekyll-graph/tags.rb +1 -1
- data/lib/jekyll-graph/version.rb +1 -1
- data/lib/jekyll-graph.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: '038de01bbe85bc24af50ccb57201b05a10652580dd8143bfe5a0e465b8a7a291'
|
|
4
|
+
data.tar.gz: 2af7e4481d0bab8691a34675fb48b51bab6f5a4a422f4c0f460581f3e1cc70a9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5b25396bcf649bcb017f9d713c4393be1e86ea3728e970146115ee1524c9f6e38c68a78ff996329eac93c12716ddb213ca9583c1962e2ba396301ae785c7f3ef
|
|
7
|
+
data.tar.gz: d4f7cccfb7204a986e7d5f8aa49a049d773680b6a69e5a6c6bd10476fcee8fb7a08bbd4f7e3ba134722fba5af11bcad548a8ea4e5b8ea85f3371b5817eddc7bd
|
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
⚠️ Expect breaking changes and surprises until otherwise noted (likely by v0.1.0 or v1.0.0). ⚠️
|
|
6
6
|
|
|
7
|
-
Jekyll-Graph generates data and renders a graph that allows visitors to navigate a jekyll site by clicking nodes in the graph. Nodes are generated from the site's markdown files. Links for the tree graph are generated from `jekyll-namespaces` and links for the net-web graph from `jekyll-wikilinks
|
|
7
|
+
Jekyll-Graph generates data and renders a graph that allows visitors to navigate a jekyll site by clicking nodes in the graph. Nodes are generated from the site's markdown files. Links for the tree graph are generated from [`jekyll-namespaces`](https://github.com/manunamz/jekyll-namespaces) and links for the net-web graph from [`jekyll-wikilinks`](https://github.com/manunamz/jekyll-wikilinks).
|
|
8
8
|
|
|
9
9
|
This gem is part of the [jekyll-bonsai](https://manunamz.github.io/jekyll-bonsai/) project. 🎋
|
|
10
10
|
|
|
@@ -14,14 +14,14 @@ Follow the instructions for installing a [jekyll plugin](https://jekyllrb.com/do
|
|
|
14
14
|
|
|
15
15
|
## Usage
|
|
16
16
|
|
|
17
|
-
1. Add `{%
|
|
17
|
+
1. Add `{% jekyll_graph %}` to the site head:
|
|
18
18
|
|
|
19
19
|
```html
|
|
20
20
|
<head>
|
|
21
21
|
|
|
22
22
|
...
|
|
23
23
|
|
|
24
|
-
{%
|
|
24
|
+
{% jekyll_graph %}
|
|
25
25
|
|
|
26
26
|
</head>
|
|
27
27
|
```
|
|
@@ -82,10 +82,15 @@ graph:
|
|
|
82
82
|
```
|
|
83
83
|
|
|
84
84
|
`enabled`: Turn off the plugin by setting to `false`.
|
|
85
|
+
|
|
85
86
|
`exclude`: Exclude specific jekyll document types (`posts`, `pages`, `collection_items`).
|
|
87
|
+
|
|
86
88
|
`assets_path`: Custom graph file location from the root of the generated `_site/` directory.
|
|
89
|
+
|
|
87
90
|
`scripts_path`: Custom graph scripts location from the assets location of the generated `_site/` directory (If `assets_path` is set, but `scripts_path` is not, the location will default to `_site/<assets_path>/js/`).
|
|
91
|
+
|
|
88
92
|
`tree.enabled` and `net_web.enabled`: Toggles on/off the `tree` and `net_web` graphs, respectively.
|
|
93
|
+
|
|
89
94
|
`tree.force` and `net_web.force`: These are force variables from d3's simulation forces. You can check out the [docs for details](https://github.com/d3/d3-force#simulation_force).
|
|
90
95
|
|
|
91
96
|
Force values will likely need to be played with depending on the div size and number of nodes. [jekyll-bonsai](https://manunamz.github.io/jekyll-bonsai/) currently uses these values:
|
data/lib/jekyll-graph/tags.rb
CHANGED
data/lib/jekyll-graph/version.rb
CHANGED
data/lib/jekyll-graph.rb
CHANGED
|
@@ -15,7 +15,7 @@ Jekyll::Hooks.register :site, :after_init do |site|
|
|
|
15
15
|
end
|
|
16
16
|
|
|
17
17
|
require_relative "jekyll-graph/tags"
|
|
18
|
-
Liquid::Template.register_tag "
|
|
18
|
+
Liquid::Template.register_tag "jekyll_graph", Jekyll::Graph::HeadTag
|
|
19
19
|
Liquid::Template.register_tag "graph_scripts", Jekyll::Graph::GraphScriptTag
|
|
20
20
|
|
|
21
21
|
module Jekyll
|