set_up_leanpub {ottrpal} | R Documentation |
Set up Manuscript folder for Leanpub publishing
Description
Set up Manuscript folder for Leanpub publishing
Usage
set_up_leanpub(
path = ".",
clean_up = FALSE,
render = TRUE,
output_dir = "manuscript",
make_book_txt = FALSE,
quiz_dir = "quizzes",
run_quiz_checks = FALSE,
remove_resources_start = FALSE,
verbose = TRUE,
footer_text = NULL,
embed = NULL
)
Arguments
path |
path to the bookdown book, must have a '_bookdown.yml' file |
clean_up |
TRUE/FALSE the old output directory should be deleted and everything created fresh. |
render |
if 'TRUE', then [bookdown::render_book()] will be run on each Rmd. |
output_dir |
output directory to put files. It should likely be relative to path |
make_book_txt |
Should [ottrpal::bookdown_to_book_txt()] be run to create a 'Book.txt' in the output directory? |
quiz_dir |
directory that contains the quiz .md files that should be checked and incorporated into the Book.txt file. If you don't have quizzes, set this to NULL |
run_quiz_checks |
TRUE/FALSE run quiz checks |
remove_resources_start |
remove the word 'resources/' at the front of any image path. |
verbose |
print diagnostic messages |
footer_text |
Optionally can add a bit of text that will be added to the end of each file before the references section. |
embed |
is this being run by bookdown_to_embed_leanpub? TRUE/FALSE |
Value
A list of output files and diagnostics