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

Add a --cname option to create the CNAME file #1803

Closed
Gerrit0 opened this issue Nov 24, 2021 · 1 comment
Closed

Add a --cname option to create the CNAME file #1803

Gerrit0 opened this issue Nov 24, 2021 · 1 comment
Labels
enhancement Improved functionality good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged

Comments

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Nov 24, 2021

Search Terms

CNAME GitHub pages

Problem

The repro for Gerrit0/typedoc-plugin-missing-exports#4 has a a build script which copies a CNAME file so that GitHub Pages works properly. We should make this extra build step easier.

Suggested Solution

Add an option --cname, which will result in TypeDoc creating a CNAME file with the contents of that option.

@Gerrit0 Gerrit0 added enhancement Improved functionality help wanted Contributions are especially encouraged good first issue Easier issue for first time contributors labels Nov 24, 2021
@matteobruni
Copy link
Collaborator

I've just seen this issue (and it refers to my project 🤣). I don't use this anymore since the docs folder is inside another website but it could be useful for someone else.

I think a cname string option could fit, that value will be written inside the CNAME file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged
Projects
None yet
Development

No branches or pull requests

2 participants