From efd1423bde3ff4492dd7bc399f219e4a4edfd59c Mon Sep 17 00:00:00 2001 From: Will Boyd Date: Mon, 20 Jan 2025 11:56:58 -0500 Subject: [PATCH] Update documentation for frontmatter.js change --- CONTRIBUTING.md | 4 +--- src/settings.js | 2 +- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbfa64b..bdf4c6b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,8 +16,6 @@ Keeping the wizard as short as possible is a priority. Pull requests that add op ## Adding Frontmatter Fields -Similarly, default frontmatter output is limited to just a few widely used fields to avoid bloat. However, you may add new optional frontmatter fields. - -To do so, follow the instructions in [/src/frontmatter/example.js](https://github.com/lonekorean/wordpress-export-to-markdown/blob/master/src/frontmatter/example.js). +Similarly, default frontmatter output is limited to just a few widely used fields to avoid bloat. However, you may add new optional frontmatter fields to [/src/frontmatter.js](https://github.com/lonekorean/wordpress-export-to-markdown/blob/master/src/frontmatter.js). Users will be able to include your new frontmatter field by editing `frontmatter_fields` in [settings.js](https://github.com/lonekorean/wordpress-export-to-markdown/blob/master/src/settings.js). diff --git a/src/settings.js b/src/settings.js index 195b8f8..111ed0e 100644 --- a/src/settings.js +++ b/src/settings.js @@ -1,4 +1,4 @@ -// Which fields to include in frontmatter. Look in /src/frontmatter to see available fields. +// Which fields to include in frontmatter. Look in /src/frontmatter.js 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'.