File: create_book.Rd

package info (click to toggle)
r-cran-bookdown 0.32%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,664 kB
  • sloc: javascript: 11,322; makefile: 21; sh: 20
file content (30 lines) | stat: -rw-r--r-- 922 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/skeleton.R
\name{create_book}
\alias{create_book}
\alias{create_gitbook}
\alias{create_bs4_book}
\title{Create a bookdown project}
\usage{
create_gitbook(path)

create_bs4_book(path)
}
\arguments{
\item{path}{Absolute path to an empty directory in which to create the bookdown project.
In the RStudio IDE, if \pkg{rstudioapi} package available,
an RStudio project will be created.}
}
\description{
Create a bookdown project with multiple book output formats,
including HTML. Choose one of two HTML book output formats:
}
\details{
\itemize{
\item Use \code{create_gitbook()} to use \code{bookdown::gitbook()} output format
\item Use \code{create_bs4_book()} to use a \code{bookdown::bs4_book()} output format
}

The function will create a folder with file structure for a bookdown project,
and example files with information on how to start.
}