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

githubPages option does not generate .nojekyll file #2635

Closed
scottschreckengaust opened this issue Jul 10, 2024 · 2 comments
Closed

githubPages option does not generate .nojekyll file #2635

scottschreckengaust opened this issue Jul 10, 2024 · 2 comments
Labels
bug Functionality does not match expectation no bug This is expected behavior

Comments

@scottschreckengaust
Copy link

Search terms

--githubPages, .nojekyll

Expected Behavior

Expecting a .nojekyll file in the destination output folder.

The documentation states:

--githubPages Generate a .nojekyll file to prevent 404 errors in GitHub Pages. Defaults to true

Actual Behavior

There is no .nojekyll file generated, and if there is a .nojekyll file it is deleted.

Steps to reproduce the bug

touch docs/.nojekyll
typedoc --plugin typedoc-plugin-markdown

The .nojekyll file will be deleted.

Environment

  • Typedoc version: 0.26.3
  • TypeScript version: 5.5.3
  • Node.js version: 20.9.0
  • OS: macOS Sonoma 14.5 M2
@scottschreckengaust scottschreckengaust added the bug Functionality does not match expectation label Jul 10, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jul 10, 2024

typedoc-plugin-markdown

This plugin completely overwrites TypeDoc's renderer, so anything which uses renderer events, like this option, is disabled by it.

@scottschreckengaust
Copy link
Author

Resolved.

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 no bug This is expected behavior
Projects
None yet
Development

No branches or pull requests

2 participants