dotnet / dotnet/docfx

[Feature Request] Remove automatic `_disableToc` set condition

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

Description

**Is your feature request related to a problem? Please describe.**
On current docfx implementation.
docfx automatically disable TOC Area when (`model._navPath === model._tocPath`) condition met.

This behavior is not documented and it's confusing for user.
who using top-level `toc.yml` for both top-navigation and TOC.

This behavior can be changed by explicitly set `disableToc:false` or `_layout: landing` setting.
So I willing to remove this condition from template.

**Describe the solution you'd like**
Remove (`model._navPath === model._tocPath`) condition from following files.

- [conceptual.html.primary.js](https://github.com/filzrev/docfx/blob/fe56b5addb1447977a2890e8bd812f6be087cf0d/templates/default/conceptual.html.primary.js#L13)
- [ManagedReference.html.primary.js](https://github.com/filzrev/docfx/blob/main/templates/default/ManagedReference.html.primary.js#L27)
- [RestApi.html.primary.js](https://github.com/filzrev/docfx/blob/main/templates/default/RestApi.html.primary.js#L16)
- [UniversalReference.html.primary.js](https://github.com/filzrev/docfx/blob/main/templates/default/UniversalReference.html.primary.js#L17)

**Additional context**
This change introduce **BREAKING CHANGES** for existing users.

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.