Default readme not found

[nicfv]

Not sure why this is happening. When I add "readme": "README.md" in typedoc.json or --readme README.md in the command it works totally fine, but I swear it was able to find README files by default before. Can you please take a look at this? Thanks!

Search terms

default, readme, not, found, markdown, folder, file, config, json

Expected Behavior

Actual Behavior

Steps to reproduce the bug

./package.json

{
  "scripts": {
    "all": "rm -rf node_modules docs package-lock.json && npm i && npx typedoc src/index.ts"
  },
  "devDependencies": {
    "typedoc": "0.28.1"
  }
}

./README.md

# Title

Hello world!

./src/index.ts

export const TEST: string = 'hello world';

After those files have been created, simply run:

npm run all

Environment

• Typedoc version: 0.28.1
• TypeScript version: 5.8.2
• Node.js version: v20.17.0
• OS: Ubuntu 24.04

[Gerrit0]

TypeDoc 0.28 changed the default readme search to look for readme files adjacent to a project's package.json file.

In your case, the package.json file doesn't contain a name property that's a string, so it isn't considered in the documentation generation (this is because some projects use package.json files which only set type to switch between CJS and ESM, but aren't meant to describe package boundaries)

This was mentioned in the breaking changes for 0.28:

TypeDoc will only check for a project README file next to the discovered package.json file if --readme is not set
this change improves handling of monorepo setups where some packages have readme files and others do not, #2875.

[nicfv]

So all I need to do is add "name": "my_project_name" in package.json?

I just tested it and it seems like it worked!