learn
learn copied to clipboard
Need better instructions for rendering
The current instructions for rendering documents are without a lot of caveats that I've encountered:
-
Figures get placed into the
content/post/<postname>_files/figure_<something>
directory by default and require the contributor to manually move them tostatic/post/<postname>_files/figure_<something>
-
Pandoc 2.x (shipped with the preview version of Rstudio) has deprecated
markdown_github
and now usesgfm
for rendering. I've fixed this in 61ac7b716491e740add4984288766e7d3cd3a77a for therender_new_rmds_to_md()
, but it currently means that we can't put the rendering information in the header and expect it to work for everyone. -
Due to Hugo, relative paths for figure references will not work, resulting in an error if the document is rendered by clicking the "knit" button. I believe this can be circumvented by using
knitr::include_graphics()
withhere()
(i.e. https://github.com/zkamvar/dissertation/blob/master/chapters/00-introduction.Rmd#L157). -
I've found myself using the following command a lot:
unlink("content/post/practical-stegen.md"); learn::render_new_rmds_to_md()