Guide

Configuration


You can specify custom configuration using .automdrc or automd.config (with .ts, .mjs, .json, ... powered by unjs/c12)

Syntax

Example: .automdrc

file=DOCS.md

Example: automd.config.js

/** @type {import("automd").Config} */
export default {
  file: "DOCS.md",
};

Available Configs

dir

  • Type: string
  • Default: current working directory

Working directory where paths are resolved from.

You can use --dir to override with CLI.

file

  • Type: string
  • Default: README.md

The markdown file name or path (relative to dir).

You can use --file to override with CLI.

generators

  • Type: object
  • Default: {}

A map of generator names to custom generators.