10h30/wordpress-export-to-markdown
1
0
Fork 0
mirror of https://github.com/10h30/wordpress-export-to-markdown.git synced 2026-06-05 15:09:59 +09:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for frontmatter.js change

Browse Source
This commit is contained in:
Will Boyd
2025-01-20 11:56:58 -05:00
parent c6a6c1e1cc
commit efd1423bde
2 changed files with 2 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+1 -3
View File
@@ -16,8 +16,6 @@ Keeping the wizard as short as possible is a priority. Pull requests that add op
## Adding Frontmatter Fields ## 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. 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).
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).
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). 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).
src/settings.js
+1 -1
View File
@@ -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 // 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 // field by providing an alias after a ':'. For example, 'date:created' will include 'date' in
// frontmatter, but renamed to 'created'. // frontmatter, but renamed to 'created'.