tests/testthat/_snaps/build-home-index.md

data_home_sidebar() works by default

Code
  cat(data_home_sidebar(pkg))
Output
  <div class='license'>
  <h2 data-toc-skip>License</h2>
  <ul class='list-unstyled'>
  <li><a href='https://www.r-project.org/Licenses/GPL-3'>GPL-3</a></li>
  </ul>
  </div>


  <div class='citation'>
  <h2 data-toc-skip>Citation</h2>
  <ul class='list-unstyled'>
  <li><a href='authors.html#citation'>Citing testpackage</a></li>
  </ul>
  </div>

  <div class='developers'>
  <h2 data-toc-skip>Developers</h2>
  <ul class='list-unstyled'>
  <li>Hadley Wickham <br />
  <small class = 'roles'> Author, maintainer </small>  </li>
  <li>RStudio <br />
  <small class = 'roles'> Copyright holder, funder </small>  </li>
  </ul>
  </div>

  <div class='dev-status'>
  <h2 data-toc-skip>Dev Status</h2>
  <ul class='list-unstyled'>
  <li>placeholder</li>
  </ul>
  </div>
<div class="developers">
<h2 data-toc-skip>Developers</h2>
<ul class="list-unstyled">
<li>Hadley Wickham <br><small class="roles"> Author, maintainer </small>  </li>
<li>RStudio <br><small class="roles"> Copyright holder, funder </small>  </li>
<li><a href="authors.html">More about authors...</a></li>
</ul>
</div>

data_home_sidebar() errors well when no HTML file

Can't locate 'file.html'.
x home.sidebar.html in _pkgdown.yml is misconfigured.

data_home_sidebar() can get a custom markdown formatted component

<div class="fancy-section">
<h2 data-toc-skip>Fancy section</h2>
<ul class="list-unstyled">
<li><p>How <em>cool</em> is pkgdown?!</p></li>
</ul>
</div>

data_home_sidebar() can add a README

<div class="table-of-contents">
<h2 data-toc-skip>Table of contents</h2>
<ul class="list-unstyled">
<li><nav id="toc"></nav></li>
</ul>
</div>

data_home_sidebar() outputs informative error messages

Code
  data_home_sidebar(pkg)
Condition
  Error:
  ! Can't find component home.sidebar.components.fancy.
  i Edit _pkgdown.yml to define it.
Code
  data_home_sidebar(pkg)
Condition
  Error:
  ! Can't find components home.sidebar.components.fancy and home.sidebar.components.cool.
  i Edit _pkgdown.yml to define them.
Code
  data_home_sidebar(pkg)
Condition
  Error:
  ! Can't find component home.sidebar.components.fancy.title.
  i Edit _pkgdown.yml to define it.
Code
  data_home_sidebar(pkg)
Condition
  Error:
  ! Can't find components home.sidebar.components.fancy.title and home.sidebar.components.fancy.text.
  i Edit _pkgdown.yml to define them.


Try the pkgdown package in your browser

Any scripts or data that you put into this service are public.

pkgdown documentation built on May 29, 2024, 10:27 a.m.