auto-front-matter

Automatic Front Matter for Markdown

features

auto-front-matter provides two commands: auto-front-matter watch and auto-front-matter create.

1. auto-front-matter watch

Automatically insert lastmod and duration when saving the md file.

2. auto-front-matter create

Installation

npm install -D auto-front-matter

A frontmatter.json file is required in the project directory. The frontmatter.json file supports the following fields:

• dirname: Specify the directory to be updated.using glob, default current directory.
• globOptions: glob's options.
• insertLastMod: Whether to insert lastmod in front-matter, default true.
• insertReadTime: Whether to insert duration in front-matter, default true.
• newFileIsInsertLastMod: Whether to insert lastmod in front-matter for uncommitted file, default false.
• newFileIsInsertReadTime: Whether to insert duration in front-matter for uncommitted file, default false.
• wordsPerMinute: words per minute, default 500.
• template: Creating Markdown file depends on this template, default GET_DEFAULT_FRONT_MATTER.

export const GET_DEFAULT_FRONT_MATTER = () => {
	return {
		data: {
			date: new Date(new Date().toISOString()),
			author: "CondorHero",
			tags: ["hello", "world"],
			categories: "blog",
		},
		content: "\n# Hello World!\n",
	};
};

License

MIT