autofm

Automatic front matter generator for Markdown files.

This tool rewrites your Markdown. Review the config, enable backup if needed, and try it on a copy first.

Install

npm install -g autofm

Quick start

In the blog / docs repo you want to watch — not in this package repo:

autofm init-config --preset hexo
autofm --init
autofm

That writes .autofm/config.json next to _posts, fills missing front matter, then watches for new files.

<your-blog>/
  .autofm/config.json
  _posts/
  _drafts/

Do not put autofm-config.json at the content root or in this package root. See docs/config.md.

Common commands

autofm --help
autofm --dir ./blog
autofm --init              # backfill existing files, then exit
autofm --force             # overwrite existing front matter
autofm --ct                # regenerate categories and tags only
autofm --config ./path/to/config.json

Development

yarn install
yarn build
node ./dist/index.js --help

Docs

• Getting started
• CLI
• Config
• Templates
• Architecture

License

GPL-3.0-only