example output when building locally does not match what's on the site

This issue has been tracked since 2023-01-19.

Search terms

TypeDoc Example

Expected Behavior

https://typedoc.org/example/index.html shows
image

I was actually trying to figure out how you got that text.

Actual Behavior

Building locally shows

image

Steps to reproduce the bug

from the file

  1. Build TypeDoc: npm install and npm run build in the root directory.
  2. cd example
  3. npm install (the example has its own package.json)
  4. Typecheck the example: npm run tsc
  5. Build the docs: npm run typedoc

Environment

  • Typedoc version: latest master
  • TypeScript version:
  • Node.js version: 16.18.1
  • OS: Windows
Gerrit0 wrote this answer on 2023-01-21

This is caused by the name option. I'm not sure why that's specified in the config file for the site rather than the base config...

https://github.com/TypeStrong/typedoc-site/blob/master/example.typedoc.json

trajano wrote this answer on 2023-01-21

OK I was looking at the examples folder. But at least that helps.

More Details About Repo
Owner Name TypeStrong
Repo Name typedoc
Full Name TypeStrong/typedoc
Language TypeScript
Created Date 2014-05-24
Updated Date 2023-03-19
Star Count 6487
Watcher Count 68
Fork Count 639
Issue Count 48

YOU MAY BE INTERESTED

Issue Title Created Date Updated Date