vignettes/example.Rmd illustrates all required metadata used by andrew.
| Markdown YAML front matter key | Required | Note |
|---|---|---|
| title | ||
| subtitle | ||
| author | ||
| image | Preferable as 900×600 pixels. | |
| image-alt |
andrew uses Quarto and pkgdown uses R Markdown to convert Markdown to HTML. Because Quarto and R Markdown are not 100% compatible, we provide a comparison of features in the next table.
| Feature | andrew |
pkgdown |
Notes |
|---|---|---|---|
| Pandoc’s Markdown | 👍 | 👍 | |
| Images | 👍 | 👍 | As part of Pandoc’s Markdown |
| Tables | 👍 | 👍 | As part of Pandoc’s Markdown |
| Citations and Bibliographies | 👍 | 👍 | As part of Pandoc’s Markdown |
| Footnotes | 👍 | 👍 | As part of Pandoc’s Markdown |
| Math | 👍 | 👍 | Powered by MathJax as part of Pandoc’s Markdown |
| Callout Blocks | 😥 | 😥 | pkgdown does not have the CSS for callout blocks and GESIS-Methods-Hub/andrew#149 |
| Cross References | 👍 | 😭 | Quarto uses an extension to citation for cross references. |
| Computation of Inline Code | 👍 | 👍 | |
| Computation of Code Chunks | 👍 | 👍 | |
| Code Annotation | 👍 | 😭 | Requires Quarto >= 1.3 |
| Title Blocks | 👍 | 👍 | Generated by Quarto based on YAML header |
| How to cite in the appendix | 👍 | 😥 | Generated by Quarto based on YAML header |
The link to Binder will launch RStudio IDE.
.github/workflows/pkgdown.yaml is the GitHub Actions used to create the R package website with pkgdown. Ensure that GitHub Pages' source in Settings > Pages > Build and deployment is GitHub Actions.