From a83c472c932c01b68ebe60da485528c8e7b76a19 Mon Sep 17 00:00:00 2001 From: Will Boyd Date: Fri, 23 Feb 2024 14:23:41 -0500 Subject: [PATCH] Comments --- src/frontmatter/tags.js | 2 -- src/settings.js | 26 +++++++++++++++----------- 2 files changed, 15 insertions(+), 13 deletions(-) diff --git a/src/frontmatter/tags.js b/src/frontmatter/tags.js index 63d984f..1a44d98 100644 --- a/src/frontmatter/tags.js +++ b/src/frontmatter/tags.js @@ -1,5 +1,3 @@ -const settings = require('../settings'); - module.exports = (post) => { if (!post.data.category) { return []; diff --git a/src/settings.js b/src/settings.js index 57087ce..b6a21e7 100644 --- a/src/settings.js +++ b/src/settings.js @@ -1,3 +1,7 @@ +// Which fields to include in frontmatter. Look in /src/frontmatter to see available fields. +// Order is preserved. If a field has an empty value, it will not be included. You can rename a +// field by providing an alias after a ':'. For example, 'date:created' will include 'date' in +// frontmatter, but renamed to 'created'. exports.frontmatter_fields = [ 'title', 'date', @@ -6,23 +10,23 @@ exports.frontmatter_fields = [ 'coverImage' ]; -// time in ms to wait between requesting image files -// increase this if you see timeouts or server errors +// Time in ms to wait between requesting image files. Increase this if you see timeouts or +// server errors. exports.image_file_request_delay = 500; -// time in ms to wait between saving Markdown files -// increase this if your file system becomes overloaded +// Time in ms to wait between saving Markdown files. Increase this if your file system becomes +// overloaded. exports.markdown_file_write_delay = 25; -// enable this to include time with post dates -// for example, "2020-12-25" would become "2020-12-25T11:20:35.000Z" +// Enable this to include time with post dates. For example, "2020-12-25" would become +// "2020-12-25T11:20:35.000Z". exports.include_time_with_date = false; -// override post date formatting with a custom formatting string (for example: 'yyyy LLL dd') -// tokens are documented here: https://moment.github.io/luxon/#/parsing?id=table-of-tokens -// if set, this takes precedence over include_time_with_date +// Override post date formatting with a custom formatting string (for example: 'yyyy LLL dd'). +// Tokens are documented here: https://moment.github.io/luxon/#/parsing?id=table-of-tokens. If +// set, this takes precedence over include_time_with_date. exports.custom_date_formatting = ''; -// categories to be excluded from post frontmatter -// this does not filter out posts themselves, just the categories listed in their frontmatter +// Categories to be excluded from post frontmatter. This does not filter out posts themselves, +// just the categories listed in their frontmatter. exports.filter_categories = ['uncategorized'];