xmitter-11ty/eleventy.config.js

179 lines
5.8 KiB
JavaScript
Raw Normal View History

2023-01-23 13:15:30 -05:00
const path = require("path");
2022-05-13 17:10:00 -04:00
const { DateTime } = require("luxon");
const markdownItAnchor = require("markdown-it-anchor");
2023-01-23 09:17:38 -05:00
const pluginRss = require("@11ty/eleventy-plugin-rss");
const pluginSyntaxHighlight = require("@11ty/eleventy-plugin-syntaxhighlight");
const pluginNavigation = require("@11ty/eleventy-navigation");
2023-01-23 13:15:30 -05:00
const eleventyImage = require("@11ty/eleventy-img");
2023-01-23 13:34:39 -05:00
const { EleventyHtmlBasePlugin } = require("@11ty/eleventy");
2023-01-23 13:15:30 -05:00
module.exports = function(eleventyConfig) {
2023-01-23 12:37:44 -05:00
// Copy the contents of the `public` folder to the output folder
// For example, `./public/css/` ends up in `_site/css/`
eleventyConfig.addPassthroughCopy({
"./public/": "/",
"./node_modules/prismjs/themes/prism-okaidia.css": "/css/prism-okaidia.css"
});
2023-01-23 15:39:36 -05:00
// Run Eleventy when these files change:
// https://www.11ty.dev/docs/watch-serve/#add-your-own-watch-targets
// Process content images to the image pipeline.
eleventyConfig.addWatchTarget("content/**/*.{png,jpeg}");
2023-01-23 15:39:36 -05:00
2023-01-23 13:15:30 -05:00
// Plugins
2023-01-23 12:37:44 -05:00
eleventyConfig.addPlugin(pluginRss);
eleventyConfig.addPlugin(pluginSyntaxHighlight);
eleventyConfig.addPlugin(pluginNavigation);
eleventyConfig.addPlugin(EleventyHtmlBasePlugin);
2023-01-23 15:39:36 -05:00
// Eleventy Image shortcode
// https://www.11ty.dev/docs/plugins/image/
2023-01-23 13:34:39 -05:00
eleventyConfig.addPlugin(eleventyConfig => {
2023-01-23 17:35:14 -05:00
function relativeToInputPath(inputPath, relativeFilePath) {
2023-01-23 17:43:00 -05:00
let split = inputPath.split("/");
2023-01-23 17:35:14 -05:00
split.pop();
2023-01-23 17:43:00 -05:00
2023-01-23 17:35:14 -05:00
return path.resolve(split.join(path.sep), relativeFilePath);
}
2023-01-23 15:39:36 -05:00
eleventyConfig.addAsyncShortcode("image", async function imageShortcode(src, alt, sizes) {
2023-01-23 13:34:39 -05:00
let file = relativeToInputPath(this.page.inputPath, src);
let metadata = await eleventyImage(file, {
widths: ["auto"],
2023-01-23 15:39:36 -05:00
// You can add "avif" or "jpeg" here if youd like!
2023-01-23 13:34:39 -05:00
formats: ["webp", "png"],
2023-01-23 15:39:36 -05:00
outputDir: path.join(eleventyConfig.dir.output, "img"), // Advanced usage note: `eleventyConfig.dir` works here because were using addPlugin.
2023-01-23 13:34:39 -05:00
});
let imageAttributes = {
alt,
sizes,
loading: "lazy",
decoding: "async",
};
return eleventyImage.generateHTML(metadata, imageAttributes);
2023-01-23 13:15:30 -05:00
});
2023-01-23 15:39:36 -05:00
});
2023-01-23 13:15:30 -05:00
// Drafts implementation, see `content/content.11tydata.js` for additional code.
2023-01-23 17:48:51 -05:00
// This section *could* be simplified to an environment variable in an npm script,
// but this way an ENV is not required and this code works cross-platform.
eleventyConfig.addPlugin(function enableDrafts(eleventyConfig) {
let logged = false;
eleventyConfig.on("eleventy.before", ({runMode}) => {
// Only show drafts in serve/watch modes
if(runMode === "serve" || runMode === "watch") {
process.env.BUILD_DRAFTS = true;
2023-01-23 18:04:23 -05:00
// Only log once.
2023-01-23 17:48:51 -05:00
if(!logged) {
console.log( "[11ty/eleventy-base-blog] including `draft: true` posts" );
}
logged = true;
}
});
})
2023-01-23 13:15:30 -05:00
// Filters
2023-01-23 18:04:23 -05:00
eleventyConfig.addFilter("readableDate", (dateObj, format, zone) => {
// Formatting tokens for Luxon: https://moment.github.io/luxon/#/formatting?id=table-of-tokens
return DateTime.fromJSDate(dateObj, { zone: zone || "utc" }).toFormat(format || "dd LLLL yyyy");
2023-01-23 12:37:44 -05:00
});
eleventyConfig.addFilter('htmlDateString', (dateObj) => {
2023-01-23 18:04:23 -05:00
// dateObj input: https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-date-string
2023-01-23 12:37:44 -05:00
return DateTime.fromJSDate(dateObj, {zone: 'utc'}).toFormat('yyyy-LL-dd');
});
// Get the first `n` elements of a collection.
eleventyConfig.addFilter("head", (array, n) => {
if(!Array.isArray(array) || array.length === 0) {
return [];
}
if( n < 0 ) {
return array.slice(n);
}
return array.slice(0, n);
});
// Return the smallest number argument
eleventyConfig.addFilter("min", (...numbers) => {
return Math.min.apply(null, numbers);
});
// Return all the tags used in a collection
eleventyConfig.addFilter("getAllTags", collection => {
let tagSet = new Set();
for(let item of collection) {
(item.data.tags || []).forEach(tag => tagSet.add(tag));
}
return Array.from(tagSet);
});
eleventyConfig.addFilter("filterTagList", function filterTagList(tags) {
return (tags || []).filter(tag => ["all", "nav", "post", "posts"].indexOf(tag) === -1);
});
// Customize Markdown library settings:
eleventyConfig.amendLibrary("md", mdLib => {
mdLib.use(markdownItAnchor, {
permalink: markdownItAnchor.permalink.ariaHidden({
placement: "after",
class: "direct-link",
symbol: "#",
}),
level: [1,2,3,4],
slugify: eleventyConfig.getFilter("slugify")
});
});
2023-01-23 15:39:36 -05:00
// Features to make your build faster (when you need them)
2023-01-23 13:34:39 -05:00
// If your passthrough copy gets heavy and cumbersome, add this line
// to emulate the file copy on the dev server. Learn more:
// https://www.11ty.dev/docs/copy/#emulate-passthrough-copy-during-serve
// eleventyConfig.setServerPassthroughCopyBehavior("passthrough");
2023-01-23 12:37:44 -05:00
return {
// Control which files Eleventy will process
// e.g.: *.md, *.njk, *.html, *.liquid
templateFormats: [
"md",
"njk",
"html",
"liquid"
],
// Pre-process *.md files with: (default: `liquid`)
markdownTemplateEngine: "njk",
// Pre-process *.html files with: (default: `liquid`)
htmlTemplateEngine: "njk",
// These are all optional:
2023-01-23 12:37:44 -05:00
dir: {
input: "content", // default: "."
includes: "../_includes", // default: "_includes"
data: "../_data", // default: "_data"
2023-01-23 12:37:44 -05:00
output: "_site"
2023-01-23 13:34:39 -05:00
},
2023-01-23 12:37:44 -05:00
// -----------------------------------------------------------------
2023-01-23 13:34:39 -05:00
// Optional items:
// -----------------------------------------------------------------
2023-01-23 12:37:44 -05:00
// If your site deploys to a subdirectory, change `pathPrefix`.
// Read more: https://www.11ty.dev/docs/config/#deploy-to-a-subdirectory-with-a-path-prefix
// When paired with the HTML <base> plugin https://www.11ty.dev/docs/plugins/html-base/
// it will transform any absolute URLs in your HTML to include this
// folder name and does **not** affect where things go in the output folder.
2023-01-23 13:34:39 -05:00
pathPrefix: "/",
2023-01-23 12:37:44 -05:00
};
};