|
| 1 | +--- |
| 2 | +slug: "post-template" |
| 3 | +title: Post Title in Title Case |
| 4 | +# Delete the package_version line below if your post is not about a package |
| 5 | +package_version: 0.1.0 |
| 6 | +author: |
| 7 | + - Author Name1 |
| 8 | + - Author Name2 |
| 9 | +# Set the date below to the publication date of your post |
| 10 | +date: 2020-03-10 |
| 11 | +# Minimal tags for a post about a community-contributed package |
| 12 | +# that has passed software peer review are listed below |
| 13 | +# Consult the Technical Guidelines for information on choosing tags |
| 14 | +tags: |
| 15 | + - Software Peer Review |
| 16 | + - packages |
| 17 | + - R |
| 18 | + - community |
| 19 | +# The summary below will be used by e.g. Mastodon preview cards |
| 20 | +description: "A very short summary of your post (~ 100 characters)" |
| 21 | +# If you have no preferred image for Mastodon preview cards, |
| 22 | +# delete the socialImg and socialAlt lines below |
| 23 | +# - Note "/" between year/month/day |
| 24 | +socialImg: blog/2019/06/04/post-template/name-of-image.png |
| 25 | +socialAlt: "Alternative description of the image" |
| 26 | +# the text below is for populating the "share on Twitter" button |
| 27 | +# if deleted, the title of the post will be used |
| 28 | +social: "A post about blabla by @[email protected]!" |
| 29 | +# this field is for the storing the name(s) of the editor(s) of your post |
| 30 | +# you can leave it empty until you know who'll review your PR |
| 31 | +editor: |
| 32 | +# Quarto metadata |
| 33 | +format: hugo-md |
| 34 | +knitr: |
| 35 | + opts_chunk: |
| 36 | + fig.path: "" |
| 37 | +--- |
| 38 | + |
| 39 | + |
| 40 | +This is the Quarto (.qmd) template for a blog post or tech note. |
| 41 | +To generate your post with just Markdown (.md), use that template instead. |
| 42 | + |
| 43 | +[Quarto docs for Hugo](https://quarto.org/docs/output-formats/hugo.html). |
| 44 | + |
| 45 | +Throughout this template, including the YAML, |
| 46 | +you should change "post-template" to the slug of your post, |
| 47 | +and "2019-06-04" to your publication date. |
| 48 | + |
| 49 | +Save this file under /content/blog/YYYY-MM-DD-slug/index.qmd in the local copy of your roweb3 fork. |
| 50 | + |
| 51 | +The figure paths in the resulting Markdown will already be valid so you won't need to edit the Markdown file. |
| 52 | + |
| 53 | +## Section heading in sentence case |
| 54 | + |
| 55 | +Citation of the primary literature[^1]. |
| 56 | + |
| 57 | +Citation of a website[^2]. |
| 58 | + |
| 59 | +Citation of an R package[^3]. |
| 60 | + |
| 61 | +### Subsection heading |
| 62 | + |
| 63 | +We recommend the use of [Hugo shortcodes](https://gohugo.io/content-management/shortcodes/) to include images, videos, gists, etc. |
| 64 | + |
| 65 | +**Add an image** by using a Hugo shortcode. The image is saved under `/content/blog/YYYY-MM-DD-slug/name-of-image.png`. |
| 66 | + |
| 67 | +{{{< figure src = "name-of-image.png" width = "400" alt = "this is the alternative text" >}}} |
| 68 | + |
| 69 | +Consult the Technical Guidelines for tips on changing image size, alignment, and for advice on alternative text. |
| 70 | + |
| 71 | +Below is another image, a plot generated by a code chunk, so you might see how to add alternative text in this case. |
| 72 | + |
| 73 | +```{r chunkname} |
| 74 | +#| label: fig-polar |
| 75 | +#| fig-cap: "A line plot on a polar axis" |
| 76 | +#| fig-alt: "alternative text please make it informative" |
| 77 | +plot(1:10) |
| 78 | +``` |
| 79 | + |
| 80 | +Once this file is rendered the plot above will be inserted with the correct syntax. |
| 81 | + |
| 82 | + |
| 83 | +**Add citation or footnote** text by using the format below |
| 84 | + |
| 85 | +[^1]: Sciaini, M., Fritsch, M., Scherer, C., & Simpkins, C. E. (2018). NLMR and landscapetools: An integrated environment for simulating and modifying neutral landscape models in R. Methods in Ecology and Evolution, 9(11), 2240-2248. <https://doi.org/10.1111/2041-210X.13076> |
| 86 | +[^2]: Elin Waring, Michael Quinn, Amelia McNamara, Eduardo Arino de la Rubia, Hao Zhu and Shannon Ellis (2019). skimr: Compact and Flexible Summaries of Data. R package version 1.0.7. https://CRAN.R-project.org/package=skimr |
| 87 | +[^3]: Hugo static site generator. https://gohugo.io/ |
0 commit comments