blob: b9d5b6ddd4c9fed97c6c48e8bdbbe7e7aaafa4a2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="color-scheme" content="dark light">
<link rel="icon" href="data:,">
<title>Simple Navigation Setup in Jekyll 3.9.0</title>
<link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Atom feed for blog posts" />
<link href="/rss.xml" type="application/rss+xml" rel="alternate" title="RSS feed for blog posts" />
<style>*{box-sizing:border-box;}body{font-family:sans-serif;line-height:1.33;margin:0 auto;max-width:650px;padding:1rem;}blockquote{background:rgba(0,0,0,0.1);border-left:4px solid;padding-left:5px;}img{max-width:100%;}pre{border:1px solid;overflow:auto;padding:5px;}table{text-align:left;width:100%;}.footnotes{font-size:90%;}</style>
</head>
<nav>
<a href="#menu">Menu ↓</a>
</nav>
<main>
<h1 id="simple-navigation-setup-in-jekyll-3.9.0">Simple Navigation Setup in Jekyll 3.9.0</h1>
<p>2020-09-29</p>
<p>I have found that there is a lot of information on the internet in regards to setting up “dynamic” navigation in Jekyll. The problem I’ve noticed is that a good amount of these implementations are overly complex. Here is the simplest way that I tend to use when building out <code>nav</code> elements in Jekyll (3.9.0 as of this writing).</p>
<h2 id="creating-the-directories-files">Creating the Directories & Files</h2>
<p>In your Jekyll project, at the top level, you need to create a directory called <code>_data</code>. Inside this folder we will be creating a new file called <code>navigation.yml</code>. The contents of this file will contain all your navigation links and they are rendered like so:</p>
<pre><code>- title: Home
url: /
- title: Articles
url: /articles/
- title: About
url: /about/
</code></pre>
<h2 id="dynamically-rendering-the-navigation">Dynamically Rendering the Navigation</h2>
<p>The next and final step is rendering out the navigation with a simple loop:</p>
<pre><code>{% for item in site.data.navigation %}
<li>
<a href="{{ item.url }}"><span>{{ item.title }}</span></a>
</li>
{% endfor %}
</code></pre>
<h2 id="highlight-current-page">Highlight Current Page</h2>
<p>It’s also very easy to extend this method to add a CSS class based on whether a user is on the currently selected page or not:</p>
<pre><code>{% for item in site.data.navigation %}
<li>
{% if item.url == page.url %}
<a class="active" href="{{ item.url }}"><span>{{ item.title }}</span></a>
{% else %}
<a href="{{ item.url }}"><span>{{ item.title }}</span></a>
{% endif %}
</li>
{% endfor %}
/* Custom styling for active class */
li a.active { color: red; }
</code></pre>
<p>Congrats! You now have fully functional, dynamic navigation on your Jekyll site.</p>
<footer role="contentinfo">
<h2>Menu Navigation</h2>
<ul id="menu">
<li><a href="/">Home</a></li>
<li><a href="/projects">Projects</a></li>
<li><a href="/uses">Uses</a></li>
<li><a href="/wiki">Wiki</a></li>
<li><a href="/resume">Resume</a></li>
<li><a href="/colophon">Colophon</a></li>
<li><a href="/now">Now</a></li>
<li><a href="/donate">Donate</a></li>
<li><a href="/atom.xml">RSS</a></li>
<li><a href="#top">↑ Top of the page</a></li>
</ul>
<small>
Built with <a href="https://barf.btxx.org">barf</a>. <br>
Feeds: <a href="/atom.xml">Atom</a> & <a href="/rss.xml">RSS</a><br>
Maintained with ♥ for the web. <br>
Proud supporter of <a href="https://usefathom.com/ref/DKHJVX">Fathom</a> & <a href="https://nextdns.io/?from=74d3p3h8">NextDNS</a>. <br>
The content for this site is <a href="https://creativecommons.org/licenses/by-sa/2.0/">CC-BY-SA</a>.<br> The <a href="https://git.sr.ht/~bt/bt.ht">code for this site</a> is <a href="https://git.sr.ht/~bt/bt.ht/tree/master/item/LICENSE">MIT</a>.
</small>
</footer>
|
