docfx icon indicating copy to clipboard operation
docfx copied to clipboard

Guidance for plugin development

Open mattwhitfield opened this issue 3 years ago • 2 comments

Hello

I have written a plugin for v2 that allows TOCs to use glob matching patterns to include multiple files - so you can do stuff like this in TOC.yml

- name: Some specific file
  href: someSpecificFile.md
- name: All other files
  items:
  - name: Expand{Hierarchical}
    includedFrom: '**/*.md'

I have two questions -

  1. Is there a good process for distribution for plugins?
  2. The plugin is built against the 2.59 nuget packages currently - is there any information about how to go about porting it for v3? I have tried to find information on it but I don't see any v3 preview packages on nuget.org and I couldn't find anything about plugins that was specific to v3. Apologies if my google-fu is weak.

mattwhitfield avatar Mar 31 '22 16:03 mattwhitfield

Plugins for DocFX v3 were discussed in https://github.com/dotnet/docfx/issues/5431.

KalleOlaviNiemitalo avatar Apr 01 '22 17:04 KalleOlaviNiemitalo

Thanks... I guess if TOCs in v3 don't receive native support for glob patterns then it will be a case of a pre-processor for v3.

mattwhitfield avatar Apr 02 '22 12:04 mattwhitfield