PWDoc

PWDoc is a TypeScript documentation generator focused on Angular projects. It parses JSDoc comments and generates MKDocs-compatible Markdown output.

Features

• Parses Angular and TypeScript entities (components, services, directives, pipes, guards, interfaces, enums, functions, classes).
• Generates structured Markdown pages with navigation per language.
• Includes code view and component style tabs.
• Supports i18n maps and i18n template generation.
• Supports external i18n merge/override files and configurable legal page generation.

Install

npm install -D @pixelway_ch/pwdoc

CLI

npx pwdoc --config pwdoc.config.json

Generate i18n template for one file:

npx pwdoc --i18n-template src/app/app.component.ts --lang fr

Generate i18n template for a full project:

npx pwdoc --i18n-template-all --lang fr --config pwdoc.config.json

Setup Guides

• Angular setup guide
• React setup guide
• PWDoc i18n extension guide

Configuration Example

{
  "entryPoints": ["src"],
  "tsconfigPath": "tsconfig.app.json",
  "outDir": "pwdoc-site",
  "i18nDir": "pwdoc-i18n",
  "defaultLang": "en",
  "exclude": ["**/*.spec.ts"]
}

Development

npm install
npm run build
npm run test

Build PWDoc-generated docs and then build MkDocs Material sites for both languages (en, fr):

make install-docs-prereqs
make docs-material

Preview (make docs-material)

English (desktop):

English (mobile):

French (desktop):

French (mobile):

License

MIT