elong0527 / r4csr

R for Clinical Study Report and Submission
https://r4csr.org/
Other
70 stars 33 forks source link

Migrate to Quarto book #104

Closed nanxstats closed 1 year ago

nanxstats commented 1 year ago

This PR fixes #102

HTML preview: https://nanx.me/r4csr/ PDF preview: https://nanx.me/r4csr/R-for-Clinical-Study-Reports-and-Submission.pdf

The migration is almost seamless. However, to be productive, sufficient knowledge about the previous bookdown setup and Quarto is recommended for similar migrations.

For HTML output, the URLs to some chapters are now changed. This is because the {#name} convention in level 1 headings do not indicate the URL slug anymore. Instead, the chapter URLs are consistent with the file names (chapter-name.qmd will generate chapter-name.html). The {#name} labels now only serve as cross reference labels. They also need special prefixes such as #sec- to work in Quarto, so I updated some of them.

For PDF output, I did not migrate the previous svmono class. Instead, I used the Quarto default PDF output class scrbook from KOMA Script as it's a template that just works. We can revisit if a more complicated custom PDF output options is needed.

For GitHub Actions, the updated workflow might just work for your existing repo after merge. Since my forked repo does not have a gh-pages branch, I had to run quarto publish gh-pages once locally, to make it work (setup branches, etc.), following the quarto-actions docs. If publishing doesn't work after merge, maybe try this.