dotnet / dotnet/docfx

Suggestion: make docfx to support to be included as a part in a site generated by other tools

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

Description

Make docfx to play well with other tools. I already have a static site generated by my toolset. And I want to include several areas with api doc generated by docfx. For example for TS and .NET APIs. Currently I have to customize docfx template heavily. I have to change templates, css, js. As docfx assets aren't at the site root, they are inside a area (like /client-api and /server-api). And I don't want docfx asset to be loaded twice from that subfolders. So have a folder with all docfx assets at the same level as api areas. It's just an example why I need to customize js (all such things are hard-coded inside js).

So in general I'd suggest to think about supporting such scenarios when docfx generates one or several subarea of some big static site that generated by other tool (or not generated, it can be some sort of CMS) .

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.