Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme configuration doesn't seem to be working #1608

Closed
dregert opened this issue Jun 23, 2021 · 2 comments
Closed

readme configuration doesn't seem to be working #1608

dregert opened this issue Jun 23, 2021 · 2 comments
Labels
bug Functionality does not match expectation

Comments

@dregert
Copy link

dregert commented Jun 23, 2021

Search terms

'readme' key not working when specified in the configuration file (typedoc 0.21.0)

Expected Behavior

Expected the "readme" configuration inside the options file to work.

Actual Behavior

Specifying "readme: none" inside the typedoc.js file doesn't seem to be working, while the other configurations inside the same file seemed to be working fine.
When specifying "--readme none" in the command line, that works as expected.

Steps to reproduce the bug

command line

node_modules/typedoc/bin/typedoc --options etc/typedoc.js bar.ts

typedoc.js

module.exports = {
  name: 'My Project',
  out: '../build/typedoc',
  externalPattern: [
    '**/foo/**',
  ],
  excludeExternals: true,
  excludePrivate: true,
  excludeInternal: true,
  logger: 'console',
  readme: 'none',
};

Environment

  • Typedoc version: 0.21.0
  • TypeScript version: 4.3.4
  • Node.js version: 12.16.2
  • OS: Windows 10
@dregert dregert added the bug Functionality does not match expectation label Jun 23, 2021
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 25, 2021

Shoot, yep. That's busted. Thanks for the bug report!

@dregert
Copy link
Author

dregert commented Jun 28, 2021

Already tested 0.21.2 and the problem is fixed! Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

2 participants