[PYT-54] Add automatic anchor links on headers in <article>s (pytorch#3)

brsoff · web-flow · commit c362f6e301bb · 2018-08-07T12:30:57.000-04:00
diff --git a/Makefile b/Makefile
@@ -31,6 +31,7 @@ include-yarn-deps:
 	cp node_modules/jquery/dist/jquery.min.js $(VENDOR_DIR)
 	cp node_modules/popper.js/dist/umd/popper.min.js $(VENDOR_DIR)
 	cp node_modules/bootstrap/dist/js/bootstrap.min.js $(VENDOR_DIR)
+	cp node_modules/anchor-js/anchor.min.js $(VENDOR_DIR)
 
 build: install include-yarn-deps
 	$(JEKYLL) build --config _config.yml,_config_dev.yml
diff --git a/_includes/head.html b/_includes/head.html
@@ -8,4 +8,5 @@
   <script src="{{ site.baseurl }}/assets/vendor/jquery.min.js"></script>
   <script src="{{ site.baseurl }}/assets/vendor/popper.min.js"></script>
   <script src="{{ site.baseurl }}/assets/vendor/bootstrap.min.js"></script>
+  <script src="{{ site.baseurl }}/assets/vendor/anchor.min.js"></script>
 </head>
diff --git a/_layouts/default.html b/_layouts/default.html
@@ -13,5 +13,9 @@
     {{ content }}
 
     {% include footer.html %}
+
+    <script type="text/javascript">
+      anchors.add('article h2, article h3, article h4, article h5');
+    </script>
   </body>
 </html>
diff --git a/assets/main.scss b/assets/main.scss
@@ -250,3 +250,11 @@ pre {
     color: $orange;
   }
 }
+
+.anchorjs-link {
+  color: $slate;
+  &:hover {
+    color: inherit;
+    text-decoration: none;
+  }
+}
diff --git a/package.json b/package.json
@@ -1,5 +1,6 @@
 {
   "dependencies": {
+    "anchor-js": "^4.1.1",
     "bootstrap": "4.0.0",
     "jquery": "^3.3.1",
     "popper.js": "^1.14.3"
diff --git a/yarn.lock b/yarn.lock
@@ -2,6 +2,10 @@
 # yarn lockfile v1
 
 
+anchor-js@^4.1.1:
+  version "4.1.1"
+  resolved "https://registry.yarnpkg.com/anchor-js/-/anchor-js-4.1.1.tgz#943b7605e47b3c663e91e82879b682f2e186a5b1"
+
 bootstrap@4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/bootstrap/-/bootstrap-4.0.0.tgz#ceb03842c145fcc1b9b4e15da2a05656ba68469a"

Original file line number	Diff line number	Diff line change
`@@ -250,3 +250,11 @@ pre {`
`250`	`250`	`color: $orange;`
`251`	`251`	`}`
`252`	`252`	`}`
	`253`	`+`
	`254`	`+.anchorjs-link {`
	`255`	`+ color: $slate;`
	`256`	`+ &:hover {`
	`257`	`+ color: inherit;`
	`258`	`+ text-decoration: none;`
	`259`	`+ }`
	`260`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"dependencies": {`
	`3`	`+ "anchor-js": "^4.1.1",`
`3`	`4`	`"bootstrap": "4.0.0",`
`4`	`5`	`"jquery": "^3.3.1",`
`5`	`6`	`"popper.js": "^1.14.3"`