Configuration Output Formats

Configuration — Output Formats

PowerAutoDocs supports three output formats. They are fully independent — enable any combination of them.

The three formats

Format	What it produces
ADO Wiki	Structured, cross-linked pages published to your Azure DevOps Wiki via the REST API. Includes Mermaid ER diagrams and per-flow flowcharts.
Word (.docx)	A single self-contained document mirroring the wiki structure. A4, proportional column tables, auto-populated table of contents.
PDF	Same content and structure as Word, generated as a self-contained PDF. Local output only — not published to ADO Wiki.

Mermaid diagrams (the ER diagram and flow charts) are only rendered in the ADO Wiki. They are intentionally omitted from Word and PDF output.

Config

output:
  path: ./output              # folder where Word and PDF files are written
  wiki: true                  # publish to ADO Wiki
  word: true                  # generate a Word document
  wordFilename: solution-documentation.docx
  pdf: false                  # generate a PDF
  pdfFilename: solution-documentation.pdf

Field	Type	Default	Description
path	string	./output	Directory to write Word and PDF files into. Created automatically if it doesn't exist.
wiki	boolean	false	Publish documentation to ADO Wiki
word	boolean	false	Generate a Word .docx file
wordFilename	string	documentation.docx	Filename for the Word output
pdf	boolean	false	Generate a PDF file
pdfFilename	string	documentation.pdf	Filename for the PDF output

Overriding at runtime

You can override which formats are generated for a single run using CLI flags, without changing your config file:

npx powerautodocs@latest --wiki          # Wiki only
npx powerautodocs@latest --word          # Word only
npx powerautodocs@latest --pdf           # PDF only
npx powerautodocs@latest --wiki --word   # Any combination

When you pass any output flag, only the formats you specify are generated for that run — the config file is overridden. If no flags are passed, the config drives everything.

→ Full CLI flag reference