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

[Feature Request] Overrideable settings in docfx.json #8815

Closed
CaseyHofland opened this issue May 31, 2023 · 2 comments
Closed

[Feature Request] Overrideable settings in docfx.json #8815

CaseyHofland opened this issue May 31, 2023 · 2 comments
Labels
bug A bug to fix
Milestone

Comments

@CaseyHofland
Copy link

Is your feature request related to a problem? Please describe.
I am creating a github action that does most of the heavy docfx lifting. However, I would like users to specify a file (e.g. projectMetadata.json) in which they can override docfx settings.

Describe the solution you'd like
Something like an "overwrite" in the docfx.json in which I can specify files e.g. projectMetadata.json to overwrite docfx settings.

Describe alternatives you've considered
Doing it manually using command line arguments inside the github action.

Additional context
Sorry guys it's me again, this is the last feature I need I swear then I've hit all my goals.

@yufeih
Copy link
Contributor

yufeih commented Jun 1, 2023

The globalMetadataFiles config in docfx.json allows you to provide global metadata from a different file. It can override metadata not but other configs. Does that work for you?

@CaseyHofland
Copy link
Author

CaseyHofland commented Jun 1, 2023

I tried that and it seems like it should work... but it doesn't.

I've added "globalMetadataFiles": ["manual/projectMetadata.json"], inside my build property and the file looks like this:

{
    "_appTitle": "Something Really Stupid",
    "_enableSearch": "false"
}

But search is still enabled and the app title is not Something Really Stupid.

Here is the docfx.json (though the syntax should be fine).
docfx.txt

Edit 2:
The cache resets fine, so that turned out to be have nothing to do with it, and I can confidently say that the docfx.json works, it's just the globalMetadataFiles that's not working for me.

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

No branches or pull requests

2 participants