question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Bug: summary text is generated to HTML as source code markdown

See original GitHub issue

Hello! 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&#39;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:closed
  • Created 7 years ago
  • Comments:7 (3 by maintainers)

github_iconTop GitHub Comments

2reactions
aienabledcommented, Apr 11, 2016

Hello, thank you!

For anybody who have the same issue: open ReSharper Options ->Code Editing -> XML Doc Comments and change these settings:

  • Indent inside element that doesn’t contain text
  • Indent inside element that contain text

to “No indent from parent”.

Regards!

0reactions
vicancycommented, Apr 11, 2016

Hi @aienabled , this is by design that docfx renders summary, remarks, descriptions for parameters as Markdown content. There is no workaround in docfx to disable the feature for now. We’d suggest you configure ReSharper to workaround the issue.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Markdown inside <summary> and <details> not being ...
I'm trying to use the and HTML tags, but any markdown inside of them that I used is ignored. Here's a sample of...
Read more >
Rmarkdown knitr doesn't process code chunks when ...
Rmarkdown knitr doesn't process code chunks when generating preview or html doc (and only shows code literals) The specific steps to generate ......
Read more >
Rmd - not giving erros but also no html output document
Hi, I have a rmd project that runs completely without any error massage but doesn´t create any html output. If I run new...
Read more >
Improving The Accessibility Of Your Markdown
Markdown is a small text to HTML conversion language. It was created by John Gruber in 2004 with the goal of making writing...
Read more >
Using Markdown for Formatting Content
Markdown is a markup language that allows you to format plain text and convert it to HTML. Using Markdown in the Platform; Using...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found