<title>About</title>
<link href="https://roguevhs.com/about/"/>
<updated>2025-03-15T17:19:13Z</updated>
<id>https://roguevhs.com/about/</id>
<content type="html"><h2 id="intro-to-jumpstart" tabindex="-1">Intro to Jumpstart<a class="rvhs-anchor" href="https://roguevhs.com/about/#intro-to-jumpstart" aria-hidden="true">#</a></h2>
<p>This jumpstart is intended to be <em>just enough</em> to be a functional site/blog using 11ty, and also to introduce essential 11ty features.</p>
<p><a href="https://roguevhs.com/#quickstart"><strong>Review the "Quick Start"</strong></a> on the home page for how to get this starter up and running for your project.</p>
<h3 id="colophon" tabindex="-1">Colophon<a class="rvhs-anchor" href="https://roguevhs.com/about/#colophon" aria-hidden="true">#</a></h3>
<p>Hi, I'm Stephanie Eckles - @5t3ph on <a href="https://twitter.com/5t3ph">Twitter</a>, <a href="https://github.com/5t3ph">Github</a>, <a href="https://codepen.com/5t3ph">CodePen</a>, and <a href="https://dev.to/5t3ph">DEV</a>. You may know me as the author of <a href="https://moderncss.dev/">ModernCSS.dev</a> or the creator of <a href="https://stylestage.dev/">StyleStage.dev</a>. I can also be found on <a href="https://egghead.io/instructors/stephanie-eckles?af=2s65ms">egghead as an instructor</a>.</p>
<blockquote>
<p>Check out my extended collection of Eleventy resources available on <a href="https://11ty.rocks/">11ty.Rocks</a>!</p>
</blockquote>
<h3 id="jump-to" tabindex="-1">Jump to:<a class="rvhs-anchor" href="https://roguevhs.com/about/#jump-to" aria-hidden="true">#</a></h3>
<ul>
<li><a href="https://roguevhs.com/about/#global-site-data-and-env">Global Site Data and .env</a></li>
<li><a href="https://roguevhs.com/about/#template-languages-used">Template Languages Used</a></li>
<li><a href="https://roguevhs.com/about/#layout-hierarchy-and-features">Layout Hierarchy and Features</a></li>
<li><a href="https://roguevhs.com/about/#expected-frontmatter">Expected Frontmatter</a></li>
<li><a href="https://roguevhs.com/about/#permalink-style">Permalink Style</a></li>
<li><a href="https://roguevhs.com/about/#asset-handling">Asset Handling</a></li>
<li><a href="https://roguevhs.com/about/#linting">Linting</a></li>
<li><a href="https://roguevhs.com/about/#sass-framework">Sass Framework</a></li>
<li><a href="https://roguevhs.com/about/#anchor-links">Anchor links</a></li>
<li><a href="https://roguevhs.com/about/#sitemap">Sitemap</a></li>
<li><a href="https://roguevhs.com/about/#rss-feed">RSS Feed</a></li>
<li><a href="https://roguevhs.com/about/#prism-syntax-highlighting">Prism Syntax Highlighting</a></li>
<li><a href="https://roguevhs.com/about/#eleventyjs-config-features">.eleventy.js Config Features</a></li>
<li><a href="https://roguevhs.com/about/#vscode-tips">VSCode Tips</a></li>
</ul>
<h2 id="global-site-data-and-env" tabindex="-1">Global Site Data and .env<a class="rvhs-anchor" href="https://roguevhs.com/about/#global-site-data-and-env" aria-hidden="true">#</a></h2>
<p>As noted in the <a href="https://roguevhs.com/#quickstart">Quick Start</a>, there are global site data variables in <code>src/_data/meta.json</code>.</p>
<p>Those include:</p>
<ul>
<li><code>url</code> - should remain unchanged, reads from the single expected <code>.env</code> value of <code>URL</code></li>
<li><code>siteName</code> - your "brand" if you will, appended to the <code><title></code> tag, shown in the <code>sitenav</code>, displayed in the "hero" for the <code>home</code> layout, in the footer by the copyright, and as the identifier throughout the RSS feed</li>
<li><code>siteDescription</code> - used in the "description" meta tag, and below the <code>siteName</code> on the <code>home</code> layout</li>
<li><code>authorName</code> - Used in the RSS feed, intended to be your full name</li>
<li><code>twitterUsername</code> - without the "@", this value is used for the Twitter meta tags, and for the URL of the icon link in the footer</li>
</ul>
<h3 id="env" tabindex="-1">.env<a class="rvhs-anchor" href="https://roguevhs.com/about/#env" aria-hidden="true">#</a></h3>
<p>See <code>.env-sample</code> for the single expected value of <code>URL</code> which should be set to your localhost. The sample uses the default 11ty port, so you can simply rename the file to <code>.env</code> if you haven't changed the port.</p>
<p>The <code>URL</code> value is then available via the global data described previously, and can be used in templates with <code>meta.url</code>. You can see this used for the RSS feed and sitemap to create the absolute URLs.</p>
<h2 id="template-languages-used" tabindex="-1">Template Languages Used<a class="rvhs-anchor" href="https://roguevhs.com/about/#template-languages-used" aria-hidden="true">#</a></h2>
<p>Page templates are created as Nunjucks (<code>.njk</code>), and feature are added that expect Markdown for most page content.</p>
<p>The home page - <code>src/index.njk</code> - is set to process first as Markdown followed by Nunjucks. This allows mixing HTML with Markdown, with benefits being code syntax highlighting and ability to include classes on HTML elements. This functionality is provided by the <code>templateEngineOverride: md, njk</code> in the frontmatter.</p>
<p>Review the list of <a href="https://www.11ty.dev/docs/languages/">available templating languages</a> in the 11ty docs.</p>
<h2 id="layout-hierarchy-and-features" tabindex="-1">Layout Hierarchy and Features<a class="rvhs-anchor" href="https://roguevhs.com/about/#layout-hierarchy-and-features" aria-hidden="true">#</a></h2>
<p>There are two layouts and one partial included.</p>
<p><strong>New in v1.1.0</strong> - layouts are customized to be located in <code>src/_layouts</code>.</p>
<ul>
<li>
<p><code>_layouts/base.njk</code> includes the standard HTML boilerplate including meta and "og" tags in <code><head></code>.</p>
</li>
<li>
<p><code>_layouts/page.njk</code> includes the <code>sitenav.njk</code> partial and chains up to <code>base</code></p>
</li>
</ul>
<p>The <code>src/index.njk</code> template chains to the <code>base</code> layout and includes a loop that will create "cards" for everything in <code>collections.pages</code>.</p>
<h2 id="expected-frontmatter" tabindex="-1">Expected Frontmatter<a class="rvhs-anchor" href="https://roguevhs.com/about/#expected-frontmatter" aria-hidden="true">#</a></h2>
<p>There are only two fields expected:</p>
<ul>
<li><code>title</code> - essentially required, by default is used in the page <code><title></code>, and in the layout "hero".</li>
<li><code>description</code> - optional, by default appears below the title for the <code>page</code> template and is used as for the "description" meta tag.</li>
</ul>
<blockquote>
<p>If you want typed front matter, consider my plugin for <a href="https://www.npmjs.com/package/@11tyrocks/eleventy-plugin-collection-schemas">collection schemas</a></p>
</blockquote>
<h2 id="permalink-style" tabindex="-1">Permalink Style<a class="rvhs-anchor" href="https://roguevhs.com/about/#permalink-style" aria-hidden="true">#</a></h2>
<p>The default setup expects content - using any template language - within <code>pages/</code>.</p>
<p>The <code>pages.json</code> in that directory includes a <code>permalink</code> setting so that the file name is used directly to prevent 'pages' being the base of the URL.</p>
<p>You can <a href="https://www.11ty.dev/docs/permalinks/">override permalinks per file</a>.</p>
<h2 id="asset-handling" tabindex="-1">Asset Handling<a class="rvhs-anchor" href="https://roguevhs.com/about/#asset-handling" aria-hidden="true">#</a></h2>
<p>In the <code>.eleventy.js</code> config, there are included "pass-throughs" for an <code>img/</code> directory as well as <code>favicon.png</code>.</p>
<p>You can replace the included favicon, and create an <code>img</code> directory or remove the <code>addPassthroughCopy</code> if you do not have need of images.</p>
<p>Creating an <code>img</code> directory and keeping the pass-through directive will make images available at <code>/img/[image-file-path]</code> relative to the site root.</p>
<h2 id="linting" tabindex="-1">Linting<a class="rvhs-anchor" href="https://roguevhs.com/about/#linting" aria-hidden="true">#</a></h2>
<p>A <code>prettier</code> config is included, with the only update being <code>printWidth: 100</code>.</p>
<blockquote>
<p>As of v2.0.0, stylelint was removed.</p>
</blockquote>
<h2 id="sass-framework" tabindex="-1">Sass Framework<a class="rvhs-anchor" href="https://roguevhs.com/about/#sass-framework" aria-hidden="true">#</a></h2>
<p>Review the <a href="https://5t3ph.github.io/html-sass-jumpstart/">styling documentation</a> for the included minimal Sass framework, particularly the theme variables, to quickly customize the starter.</p>
<p>The only notable differences are:</p>
<ol>
<li><code>sitenav</code> - adjust the styles for the navigation header that appears on pages</li>
<li><code>rvhs-anchor</code> - styles for the <code>#</code> anchor that appears next to page headings (<a href="https://roguevhs.com/about/#anchor-links">or turn that feature off</a>) can be adjusted in <code>sass/_utilities</code></li>
<li>Additional <code>article</code>-scoped styling for typography as it appears on <code>pages</code></li>
<li>A theme for the <a href="https://roguevhs.com/about/#prism-syntax-highlighting"><code>prism</code> syntax highlighting</a> for code blocks. You can adjust or replace the theme in <code>sass/_prism</code>.</li>
</ol>
<p>Additionally, the Sass in this starter is processed using LightningCSS by way of my plugin: <a href="https://www.npmjs.com/package/@11tyrocks/eleventy-plugin-sass-lightningcss">@11tyrocks/eleventy-plugin-sass-lightningcss</a>. This affords you access to some super modern CSS features, if you choose to use them.</p>
<h3 id="fonts" tabindex="-1">Fonts<a class="rvhs-anchor" href="https://roguevhs.com/about/#fonts" aria-hidden="true">#</a></h3>
<p>The default font is <a href="https://fonts.google.com/specimen/Baloo+2">Baloo 2</a> and is locally hosted with files in <code>fonts/</code>. If you swap to a different font, be sure to remove the font files as well as the <code>@font-face</code> rules at the top of <code>sass/_fonts.scss</code>, and update the <code>$rvhs-font-family</code> Sass variable.</p>
<h2 id="anchor-links" tabindex="-1">Anchor Links<a class="rvhs-anchor" href="https://roguevhs.com/about/#anchor-links" aria-hidden="true">#</a></h2>
<p>Anchor links next to headings throughout Markdown content are generated by an add-on plugin for <code>markdownIt</code>.</p>
<p>This feature can be adjusted or removed in the <code>.eleventy.js</code> config file.</p>
<h2 id="generated-features" tabindex="-1">Generated Features<a class="rvhs-anchor" href="https://roguevhs.com/about/#generated-features" aria-hidden="true">#</a></h2>
<h3 id="sitemap" tabindex="-1">Sitemap<a class="rvhs-anchor" href="https://roguevhs.com/about/#sitemap" aria-hidden="true">#</a></h3>
<p>A <code>sitemap.xml</code> is generated from all available content.</p>
<p>To exclude non-page or non-public content from the sitemap, include <code>eleventyExcludeFromCollections: true</code> in frontmatter, or <a href="https://www.11ty.dev/docs/collections/#advanced-custom-filtering-and-sorting">create a custom filter</a>.</p>
<h3 id="rss-feed" tabindex="-1">RSS Feed<a class="rvhs-anchor" href="https://roguevhs.com/about/#rss-feed" aria-hidden="true">#</a></h3>
<p>An RSS feed is included, and output at <code>[siteurl]/feed/feed.xml</code>.</p>
<p>If publishing from Netlify, the included <code>netlify.toml</code> file will create a redirect so that the feed becomes available at <code>[siteurl]/feed</code>.</p>
<h2 id="prism-syntax-highlighting" tabindex="-1">Prism Syntax Highlighting<a class="rvhs-anchor" href="https://roguevhs.com/about/#prism-syntax-highlighting" aria-hidden="true">#</a></h2>
<p>Syntax highlighting of inline or code blocks found within Markdown content is provided by Prism via <code>@11ty/eleventy-plugin-syntaxhighlight</code>.</p>
<p>You can change the theme used in <code>sass/_prism.scss</code>.</p>
<p>Or, remove the plugin if you are not in need of code highlighting.</p>
<h2 id="eleventyjs-config-features" tabindex="-1">.eleventy.js Config Features<a class="rvhs-anchor" href="https://roguevhs.com/about/#eleventyjs-config-features" aria-hidden="true">#</a></h2>
<h3 id="overrides" tabindex="-1">Overrides<a class="rvhs-anchor" href="https://roguevhs.com/about/#overrides" aria-hidden="true">#</a></h3>
<ul>
<li><strong>Input directory</strong>: <code>src</code></li>
<li><strong>Output directory</strong>: <code>public</code></li>
<li><strong>Layout directory</strong>: <code>_layouts</code></li>
</ul>
<p>Also, <code>markdownLibrary</code> is extended to add the <code>markdownItAnchor</code> plugin for <a href="https://roguevhs.com/about/#anchor-links">anchor links</a>.</p>
<h3 id="shortcode-year" tabindex="-1">Shortcode: <code>year</code><a class="rvhs-anchor" href="https://roguevhs.com/about/#shortcode-year" aria-hidden="true">#</a></h3>
<p>Returns the current <code>YYYY</code> year, used by the footer copyright.</p>
<h3 id="filter-slug" tabindex="-1">Filter: <code>slug</code><a class="rvhs-anchor" href="https://roguevhs.com/about/#filter-slug" aria-hidden="true">#</a></h3>
<p>Makes the default <code>slug</code> function more strict to ensure things like excluding emojis and enforcing lowercase.</p>
<h2 id="vscode-tips" tabindex="-1">VSCode Tips<a class="rvhs-anchor" href="https://roguevhs.com/about/#vscode-tips" aria-hidden="true">#</a></h2>
<h3 id="nunjucks" tabindex="-1">Nunjucks<a class="rvhs-anchor" href="https://roguevhs.com/about/#nunjucks" aria-hidden="true">#</a></h3>
<p>If you haven't previously worked with Nunjucks, you will want a syntax highlighting extension: <a href="https://marketplace.visualstudio.com/items?itemName=ronnidc.nunjucks">Nunjucks</a></p>
<p>In addition, you may want to ensure Emmet works on <code>.njk</code> files by updating/adding the following in the <code>settings.json</code>:</p>
<pre class="language-json"><code class="language-json"><span class="token property">"emmet.includeLanguages"</span><span class="token operator">:</span> <span class="token punctuation">{</span><br /> <span class="token property">"nunjucks"</span><span class="token operator">:</span> <span class="token string">"html"</span><span class="token punctuation">,</span><br /><span class="token punctuation">}</span><span class="token punctuation">,</span></code></pre>
<h3 id="formatting" tabindex="-1">Formatting<a class="rvhs-anchor" href="https://roguevhs.com/about/#formatting" aria-hidden="true">#</a></h3>
<p>As noted previously, a <code>prettier</code> config is included, and you may want to get the
Prettier extension and update your VSCode settings to "Format on Save".</p>
<p>However, to format template files Prettier doesn't recognize like <code>.njk</code>, you can update the "Language Mode" on the currently open file from "Nunjucks" (or other current templating language) to "HTML" to allow formatting to be applied. Then, flip it back to re-allow the syntax highlighting if needed.</p>
<p>This is located in the VSCode bottom toolbar near the right-hand side and will display the value of the current file's detected language. Click the name to open the selector.</p>
</content>