Bug: summary text is generated to HTML as source code markdown
See original GitHub issueHello!
I’ve a problem with documentation generated for my project: summary text generated to HTML as source code markdown. Screenshot: http://screencloud.net/v/rqyX (as you can see only summary for ILogicObject appears properly).
The code from Firefox and Chrome is identical (for IGameObject
from screenshot):
<section>
<pre>
<code class="hljs actionscript">
Game object. All game objects are
<span class="hljs-keyword">implements</span>
<span class="hljs-keyword">this</span>
<span class="hljs-class">
<span class="hljs-keyword">interface</span>
.
</span>
</code>
</pre>
</section>
The code from HTML page at disk is different and also incorrect (why there is a <code>
attribute?):
<section><pre><code>Game object. All game objects are implements this interface.
</code></pre></section>
Proper code (for ILogicObject
from screenshot):
<section><p>Script object - is a special scriptable GameObject which don't have any world representation.</p>
I’m using a fresh-generated docfx project (“docfx init -q”). I’m not using any template. There are 178 MD files total, most of them has generics definitions - with a lot of < > chars. Could this affect HTML generation?
I’ve tried generating documentation for https://github.com/docascode/docfx-seed/ and it works fine (exactly the same as hosted there http://docascode.github.io/docfx-seed/index.html ). So the issue is reproducible only with documentation for my project.
Regards!
Issue Analytics
- State:
- Created 7 years ago
- Comments:7 (3 by maintainers)
Hello, thank you!
For anybody who have the same issue: open ReSharper Options ->Code Editing -> XML Doc Comments and change these settings:
to “No indent from parent”.
Regards!
Hi @aienabled , this is by design that
docfx
renderssummary
,remark
s,description
s forparameter
s as Markdown content. There is no workaround indocfx
to disable the feature for now. We’d suggest you configure ReSharper to workaround the issue.