r-lib / pkgdown

Generate static html documentation for an R package

Home Page:https://pkgdown.r-lib.org/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

References: The `section-desc` class isn't being applied the description

gadenbuie opened this issue · comments

Using pkgdown's own site for a reprex, the Build section of the reference index includes a description:

reference:
- title: Build
  desc:  Build a complete site or one of its components.

But in the rendered HTML, the section-desc class is being applied to an empty <p> tag, rather than the description.

<div class="section level2">
  <h2 id="build">Build<a class="anchor" aria-label="anchor" href="#build"></a></h2>
  <p class="section-desc"></p>
  <p>Build a complete site or one of its components.</p>
</div>

I'm guessing that this is the same root cause as #2381, i.e. we're using markdown_text_block() and then inserting into the template, and the xml2 roundtrip flattens out the extra wrapping <p>.

I think we want to allow authors to supply (e.g.) bulleted lists or multiple paragraphs, so that suggests we should change the <p> in the template to a <div>. Would that work for you @gadenbuie?

I think we want to allow authors to supply (e.g.) bulleted lists or multiple paragraphs, so that suggests we should change the <p> in the template to a <div>. Would that work for you @gadenbuie?

That would, thank you!