Skip to content

Commit a893bea

Browse files
author
John Ottenlips
committed
Auto-generate top nav and back arrow, remove subfolder nav (v0.3.2)
- Auto-generate top-level nav from pages and folders, injected after <body> - Add back arrow SVG on nested pages linking one folder up - Remove old subfolder bottom nav - Rebuild docs
1 parent ed4df38 commit a893bea

28 files changed

Lines changed: 176 additions & 47 deletions

File tree

‎agave-generator.opam‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
opam-version: "2.0"
22
name: "agave-generator"
3-
version: "0.3.1"
3+
version: "0.3.2"
44
synopsis: "Minimal markdown to HTML static site generator"
55
description: """
66
Minimal markdown to HTML for static sites with pretty URLs.

‎docs/about/index.html‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@
1717
<nav>
1818
<a href="/">Home</a>
1919
<a href="/about/">About</a>
20+
<a href="/contact/">Contact</a>
2021
<a href="/blog/">Blog</a>
2122
<a href="/sitemap/">Sitemap</a>
2223
</nav>
2324
<main>
24-
<h1 id="about-agave">About Agave</h1>
25+
<a href="/" style="display:inline-block;margin-bottom:1em;text-decoration:none;color:currentColor;opacity:0.7;" aria-label="Go back"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="19" y1="12" x2="5" y2="12"></line><polyline points="12 19 5 12 12 5"></polyline></svg></a>
26+
<h1 id="about-agave">About Agave</h1>
2527
<p>Agave is a lightweight static site generator that turns markdown files into a website.</p>
2628
<h2 id="features">Features</h2>
2729
<ul>
@@ -31,7 +33,7 @@ <h2 id="features">Features</h2>
3133
</li>
3234
<li>Per-page meta tags via shorthand notation
3335
</li>
34-
<li>Built-in themes (desert, randomphoto)
36+
<li>Built-in themes (arrakis, caladan, giediprime, ix, salusasecundus, spice, randomphoto)
3537
</li>
3638
<li>Client-side searchable sitemap
3739
</li>
@@ -40,6 +42,7 @@ <h2 id="features">Features</h2>
4042
</ul>
4143
<h2 id="how-it-works">How It Works</h2>
4244
<p>Drop your <code>.md</code> files into a directory, add a <code>base.html</code> template, and run <code>agave</code>. That's it.</p>
45+
<p><a href="/">Back to Home</a></p>
4346

4447
</main>
4548
<footer>

‎docs/blog/deploying/index.html‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@
1717
<nav>
1818
<a href="/">Home</a>
1919
<a href="/about/">About</a>
20+
<a href="/contact/">Contact</a>
2021
<a href="/blog/">Blog</a>
2122
<a href="/sitemap/">Sitemap</a>
2223
</nav>
2324
<main>
24-
<h1 id="deploying-your-agave-site">Deploying Your Agave Site</h1>
25+
<a href="/blog/" style="display:inline-block;margin-bottom:1em;text-decoration:none;color:currentColor;opacity:0.7;" aria-label="Go back"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="19" y1="12" x2="5" y2="12"></line><polyline points="12 19 5 12 12 5"></polyline></svg></a>
26+
<h1 id="deploying-your-agave-site">Deploying Your Agave Site</h1>
2527
<p>Once you've built your site, deploying is straightforward since it's just static files.</p>
2628
<h2 id="github-pages">GitHub Pages</h2>
2729
<ol>

‎docs/blog/getting-started/index.html‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@
1717
<nav>
1818
<a href="/">Home</a>
1919
<a href="/about/">About</a>
20+
<a href="/contact/">Contact</a>
2021
<a href="/blog/">Blog</a>
2122
<a href="/sitemap/">Sitemap</a>
2223
</nav>
2324
<main>
24-
<h1 id="getting-started-with-agave">Getting Started with Agave</h1>
25+
<a href="/blog/" style="display:inline-block;margin-bottom:1em;text-decoration:none;color:currentColor;opacity:0.7;" aria-label="Go back"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="19" y1="12" x2="5" y2="12"></line><polyline points="12 19 5 12 12 5"></polyline></svg></a>
26+
<h1 id="getting-started-with-agave">Getting Started with Agave</h1>
2527
<p>Setting up your first Agave site takes just a few minutes.</p>
2628
<h2 id="installation">Installation</h2>
2729
<p>Install via npm:</p>

‎docs/blog/index.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@
1717
<nav>
1818
<a href="/">Home</a>
1919
<a href="/about/">About</a>
20+
<a href="/contact/">Contact</a>
2021
<a href="/blog/">Blog</a>
2122
<a href="/sitemap/">Sitemap</a>
2223
</nav>
2324
<main>
24-
<h1 id="blog">Blog</h1>
25+
<a href="/" style="display:inline-block;margin-bottom:1em;text-decoration:none;color:currentColor;opacity:0.7;" aria-label="Go back"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="19" y1="12" x2="5" y2="12"></line><polyline points="12 19 5 12 12 5"></polyline></svg></a>
26+
<h1 id="blog">Blog</h1>
2527
<p>Recent articles:</p>
2628
<ul>
2729
<li><a href="/blog/getting-started/">Getting Started with Agave</a>
@@ -31,6 +33,7 @@ <h1 id="blog">Blog</h1>
3133
<li><a href="/blog/deploying/">Deploying Your Site</a>
3234
</li>
3335
</ul>
36+
<p><a href="/">Back to Home</a></p>
3437

3538
</main>
3639
<footer>

‎docs/blog/markdown-tips/index.html‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@
1717
<nav>
1818
<a href="/">Home</a>
1919
<a href="/about/">About</a>
20+
<a href="/contact/">Contact</a>
2021
<a href="/blog/">Blog</a>
2122
<a href="/sitemap/">Sitemap</a>
2223
</nav>
2324
<main>
24-
<h1 id="markdown-tips-and-tricks">Markdown Tips and Tricks</h1>
25+
<a href="/blog/" style="display:inline-block;margin-bottom:1em;text-decoration:none;color:currentColor;opacity:0.7;" aria-label="Go back"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="19" y1="12" x2="5" y2="12"></line><polyline points="12 19 5 12 12 5"></polyline></svg></a>
26+
<h1 id="markdown-tips-and-tricks">Markdown Tips and Tricks</h1>
2527
<p>Get the most out of your Agave markdown files.</p>
2628
<h2 id="headings-structure">Headings Structure</h2>
2729
<p>Use <code>#</code> for the page title, <code>##</code> for sections, and <code>###</code> for subsections. Agave will automatically extract the first heading for meta tags if you don't specify <code>@title</code>.</p>

‎docs/contact/index.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@
1717
<nav>
1818
<a href="/">Home</a>
1919
<a href="/about/">About</a>
20+
<a href="/contact/">Contact</a>
2021
<a href="/blog/">Blog</a>
2122
<a href="/sitemap/">Sitemap</a>
2223
</nav>
2324
<main>
24-
<h1 id="contact">Contact</h1>
25+
<a href="/" style="display:inline-block;margin-bottom:1em;text-decoration:none;color:currentColor;opacity:0.7;" aria-label="Go back"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="19" y1="12" x2="5" y2="12"></line><polyline points="12 19 5 12 12 5"></polyline></svg></a>
26+
<h1 id="contact">Contact</h1>
2527
<p>Have questions or feedback? Reach out!</p>
2628
<ul>
2729
<li>GitHub: <a href="https://github.com/jottenlips/agave">github.com/jottenlips/agave</a>
@@ -30,6 +32,7 @@ <h1 id="contact">Contact</h1>
3032
</li>
3133
</ul>
3234
<p>We'd love to hear how you're using Agave.</p>
35+
<p><a href="/">Back to Home</a></p>
3336

3437
</main>
3538
<footer>

‎docs/index.html‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
<nav>
1818
<a href="/">Home</a>
1919
<a href="/about/">About</a>
20+
<a href="/contact/">Contact</a>
2021
<a href="/blog/">Blog</a>
2122
<a href="/sitemap/">Sitemap</a>
2223
</nav>
@@ -27,26 +28,29 @@ <h2 id="pages">Pages</h2>
2728
<ul>
2829
<li><a href="/about/">About</a> — Learn about this project
2930
</li>
31+
<li><a href="/contact/">Contact</a> — Get in touch
32+
</li>
3033
<li><a href="/blog/">Blog</a> — Read the latest posts
3134
</li>
3235
<li><a href="/sitemap/">Sitemap</a> — Search all pages
3336
</li>
3437
</ul>
35-
<h2 id="themes">Theme Previews</h2>
38+
<h2 id="theme-gallery">Theme Gallery</h2>
39+
<p>Preview every built-in theme:</p>
3640
<ul>
37-
<li><a href="/themes/arrakis/">Arrakis</a> — Sun-bleached desert, endless sand, spice shimmer
41+
<li><a href="/themes/arrakis/">Arrakis</a> — Deep desert, spice orange and warm ochre
3842
</li>
39-
<li><a href="/themes/caladan/">Caladan</a> — Earth ocean theme, lush greens and deep blues
43+
<li><a href="/themes/caladan/">Caladan</a> — Ocean world, lush blues and greens
4044
</li>
41-
<li><a href="/themes/giediprime/">Giedi Prime</a> — Black and white minimalist, stark industrial
45+
<li><a href="/themes/giediprime/">Giedi Prime</a> — Black and white minimalist
4246
</li>
43-
<li><a href="/themes/ix/">Ix</a> — 90s cyberdelia, neon on dark, hacker aesthetic
47+
<li><a href="/themes/ix/">Ix</a> — 90s cyberdelia, neon on dark
4448
</li>
45-
<li><a href="/themes/salusasecundus/">Salusa Secundus</a> — Brutalist, raw concrete, heavy type
49+
<li><a href="/themes/salusasecundus/">Salusa Secundus</a> — Brutalist, raw concrete
4650
</li>
47-
<li><a href="/themes/spice/">Spice</a> — Psychedelic melange trip, molten oranges and gold
51+
<li><a href="/themes/spice/">Spice</a> — Psychedelic melange, molten oranges and gold
4852
</li>
49-
<li><a href="/themes/randomphoto/">Random Photo</a> — Clean layout with random cover photo
53+
<li><a href="/themes/randomphoto/">Random Photo</a> — Random cover photo with a light palette
5054
</li>
5155
</ul>
5256

‎docs/sitemap/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
<nav>
1818
<a href="/">Home</a>
1919
<a href="/about/">About</a>
20+
<a href="/contact/">Contact</a>
2021
<a href="/blog/">Blog</a>
2122
<a href="/sitemap/">Sitemap</a>
2223
</nav>

‎docs/themes/arrakis/index.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@
1515
<meta name="twitter:card" content="summary" />
1616
</head>
1717
<body>
18+
<nav>
19+
<a href="/">Home</a>
20+
<a href="/sitemap/">Sitemap</a>
21+
</nav>
1822
<div class="coverimage"></div>
1923
<div class="container">
2024
<div class="block">

0 commit comments

Comments
 (0)