search

Wyam2 / wyam

A modular static content and static site generator written in .NET. Fork of Wyam project.
https://wyam2.github.io/
MIT License
6 stars 1 forks source link

Support markdown in XML comments #51

Open savornicesei opened 3 years ago

savornicesei commented 3 years ago

docFX documentation states that:

docfx supports DocFX Flavored Markdown syntax inside triple-slash (///) code comments. You can disable this feature by set shouldSkipMarkup when generating metadata: docfx metadata --shouldSkipMarkup.

Same question on Reddit and it seems docFX understands markdown in XML comments.

How it might work:

  1. have a global setting that tells if content of XML comments is in markdown syntax or not
  2. if top-level tag / section contains <format type="text/markdown"> then the contained text is markdown syntax

Concerns

  1. performance when rendering XML comments written in markdown

AB#14