Rename debug.js to example.js

This commit is contained in:
Will Boyd
2024-02-24 14:16:28 -05:00
parent bb05a06280
commit a0a1224d88
2 changed files with 4 additions and 4 deletions
+1 -1
View File
@@ -18,6 +18,6 @@ Keeping the wizard as short as possible is a priority. Pull requests that add op
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, add a new `.js` file into the [/src/frontmatter](https://github.com/lonekorean/wordpress-export-to-markdown/tree/master/src/frontmatter) folder. The filename should be the name of the frontmatter field, camelcased. See the other files there for code examples.
To do so, follow the instructions in [/src/frontmatter/example.js](https://github.com/lonekorean/wordpress-export-to-markdown/tree/master/src/frontmatterexample.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).
@@ -4,8 +4,8 @@
3. Run the script to see post data dumps, to see what you can work with
4. Write your code to get and return what you want
5. Update "get whatever" comment to describe what you're getting
6. Remove your field name from the default frontmatter_fields in settings.js
7. Remove this comment block and the console debug code
6. Remove your field name from frontmatter_fields in settings.js
7. Remove this comment block and the debug console code
8. Make that pull request!
*/
@@ -15,5 +15,5 @@ module.exports = (post) => {
console.dir(post, { depth: null });
console.log('\nEND POST DATA DUMP =============================================================\n');
return 'DEBUG: ' + post.data.title[0];
return 'EXAMPLE: ' + post.data.title[0];
};