diff options
| author | Bradley Taunt <bt@btxx.org> | 2024-06-06 08:05:12 -0400 |
|---|---|---|
| committer | Bradley Taunt <bt@btxx.org> | 2024-06-06 08:05:12 -0400 |
| commit | 6b742c459266b18e2b375b35205ce8a6c02f0452 (patch) | |
| tree | b16fbb9a045e33dd6c97eb5ab72e6ff4d9237ea3 /build/simple-jekyll-navigation | |
Initial commit
Diffstat (limited to 'build/simple-jekyll-navigation')
| -rw-r--r-- | build/simple-jekyll-navigation/index.html | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/build/simple-jekyll-navigation/index.html b/build/simple-jekyll-navigation/index.html new file mode 100644 index 0000000..1f6504d --- /dev/null +++ b/build/simple-jekyll-navigation/index.html @@ -0,0 +1,75 @@ +<!doctype html> +<html lang="en" id="top"> +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <link rel="icon" href="data:,"> + <title>Simple Navigation Setup in Jekyll 3.9.0</title> + <link href="https://bt.ht/atom.xml" type="application/atom+xml" rel="alternate" title="Atom feed for blog posts" /> + <style>*{box-sizing:border-box;}body{font-family:sans-serif;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{overflow:auto;}table{text-align:left;width:100%;}</style> +</head> + +<nav> + <a href="#menu">Menu ↓</a> +</nav> + +<main> +<h1>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>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>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>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 %} +</code></pre> +<pre><code>/* 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://git.sr.ht/~bt/barf">barf</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>
\ No newline at end of file |