dotnet / dotnet/docfx

[Bug] Setting outputFileName has no effect when set inside fileMetadata

Open
#9,776 1 comment 1 reaction 0 assignees View on GitHub
static-site
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 9m
Merged PRs (30d)
11

Description

**Describe the bug**
The file metadata supports `outputFileName` as a way to indicate the desired file name of a specific document. For example the following YAML metadata can be indicated at the top of a `README.md` file to make sure the result is emitted as `index.html`.

```yml
---
outputFileName: index.html
---
```

Since `outputFileName` is part of file metadata, one would expect it to be possible to specify it as part of the `fileMetadata` section in `docfx.json`, similar to other metadata entries.

Unfortunately, the below doesn't seem to work:

```json
"build": {
"fileMetadata": {
"_appTitle": {
"**/README.md": "index title"
},
"outputFileName": {
"**/README.md": "index.html"
}
}
}
```

In this case, `_appTitle` is applied successfully (only `README.md` files will have the custom title) but files will still be named `README.html`.

**Expected behavior**
All `README.md` files should be exported as `index.html` files.

**Context (please complete the following information):**
- OS: Windows
- Docfx version: 2.75.3

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.