dotnet / dotnet/docfx

[Feature Request] Add options to disable `wordCount` feature

Open
#9,477 0 comments 0 reactions 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.**

Currently docfx calculate `wordCount` for conceptual files.
And `wordCount` is stored in `viewModel` but is not rendered to HTML (by default).

There are some custom templates that use this `wordCount` to display `Time to read`(> 1 minute to read) information.
(e.g. https://docs.dnncommunity.org/content/getting-started)

But `wordCount` is not used most use case.
So I want to disable this feature on my environment.

**Describe the solution you'd like**

1. Add options to disable `wordCount` feature.
**or**
2. Disable `wordCount` feature by default (Breaking Changes).
And add options to enable feature who want to `wordCount` feature.

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.