Authors page

Open
#248 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
r
Domain
content, web-dev

Research direction

Start by reviewing authors.Rmd and authors-raw.html, then check _site.yml and workflowr.yml to understand how the example page and sessioninfo setting are wired. Confirm the intended default authors-page behavior and whether sessioninfo should be configurable per page; done means the requested behavior and configuration scope are documented or implemented with a clear example.

Written by the indexing model from the issue text.

Description

I set up an authors page for a project of mine - maybe you find it useful as a default template.
It is a simple HTML gallery view.
It requires htmltools to render but I assume this could be required anyhow by {workflowr}?

To avoid clashes with the sessioninfo box, I turned it off for this example in workflowr.yml by setting sessioninfo: "". Is there a way to only turn if off for a single page?

Example screenshot

image

Setup

authors.Rmd

---
title: "Authors"
output:
  workflowr::wflow_html:
    toc: false
    toc_float: false
    theme: paper
workflowr:
  suppress_report: TRUE
editor_options:
  chunk_output_type: console
---

```{r, echo=FALSE}
htmltools::includeHTML("analysis/authors-raw.html")
```

authors-raw.html

<html>
<head>
<style>
div.gallery {
  margin: 5px;
  border: 1px solid #ccc;
  float: left;
  width: 180px;
}

div.gallery:hover {
  border: 1px solid #777;
}

div.gallery img {
  width: 100%;
  height: auto;
}

div.desc {
  padding: 15px;
  text-align: center;
}
</style>
</head>
<body>

<div class="gallery">
  <a target="_blank" href="https://github.com/jdblischak/workflowr">
    <img src="figure/authors/hex-workflowr.png" alt="workflowr">
  </a>
  <div class="desc">workflowr</div>
</div>
<div class="gallery">
  <a target="_blank" href="https://github.com/jdblischak/workflowr">
    <img src="figure/authors/hex-workflowr.png" alt="workflowr">
  </a>
  <div class="desc">workflowr</div>
</div>

</body>
</html>

And then a simple entry in _site.yml

  - text: Authors
    href: authors.html
Dominant language
R
Stars
906
Forks
107
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from workflowr/workflowr

All issues in workflowr/workflowr

Similar issues

More R issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.