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 #650

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

githubPages option does not generate .nojekyll file #650

scottschreckengaust opened this issue Jul 10, 2024 · 3 comments

Comments

@scottschreckengaust
Copy link

What package is the bug related to?

typedoc-plugin-markdown

Describe the issue

The documentation for typedoc states, https://typedoc.org/options/output/#githubpages:

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

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

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

FYI: I opened an issue in typedoc, TypeStrong/typedoc#2635, and it was mentioned that the plugin may be overriding

TypeDoc configuration

  • typedoc-plugin-markdown@4.1.2
  • typedoc@0.26.3
  • typescript@5.5.3
  • Node.js version: 20.9.0
  • OS: macOS Sonoma 14.5 M2

Expected behavior

Expecting a .nojekyll file in the destination output folder.

@scottschreckengaust scottschreckengaust added the bug Issue raised as a bug. label Jul 10, 2024
@scottschreckengaust
Copy link
Author

Well, I guess I needed to fully read the documentation...https://typedoc-plugin-markdown.org/docs/typedoc-usage

@tgreyuk
Copy link
Member

tgreyuk commented Jul 10, 2024

This seems like a reasonable request - if there is a use-case for this id be happy to implement.

@tgreyuk tgreyuk reopened this Jul 10, 2024
@tgreyuk tgreyuk added enhancement and removed bug Issue raised as a bug. labels Jul 10, 2024
@tgreyuk
Copy link
Member

tgreyuk commented Jul 10, 2024

@scottschreckengaust githubPages has been implemented in typedoc-plugin-markdown@4.2.0. It "false" by default.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants