docfx icon indicating copy to clipboard operation
docfx copied to clipboard

v3 Allow for custom Quote Notes

Open DavidMarquezF opened this issue 2 years ago • 2 comments

Operating System: Windows DocFX Version Used: v3

QuoteSectionNote extension is hardcoded:

private readonly List<string> _noteTypes = new() { "[!NOTE]", "[!TIP]", "[!WARNING]", "[!IMPORTANT]", "[!CAUTION]" };

It would be nice if the templates could provide these through the context (token.json I guess?). Then all the templates would have full control over these properties.

DavidMarquezF avatar Mar 17 '22 14:03 DavidMarquezF

If implemented, this would allow a custom template to recognize [!TODO] https://github.com/dotnet/docfx/issues/6268.

KalleOlaviNiemitalo avatar Mar 17 '22 16:03 KalleOlaviNiemitalo

Another option would also be to be able to maintain the current tags but allow users to set the titles themselves. I believe this is how docusaurus does it

Maybe something like:

> [!TIP](This is the title)
> Content

DavidMarquezF avatar Apr 05 '22 05:04 DavidMarquezF