-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathargonPageTemplate.Rd
55 lines (47 loc) · 1.23 KB
/
argonPageTemplate.Rd
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/argonPage.R
\name{argonPageTemplate}
\alias{argonPageTemplate}
\title{Create an HTML version of the argonPage}
\usage{
argonPageTemplate(filename = "index", path = getwd(), argonPage, view = TRUE)
}
\arguments{
\item{filename}{HTML filename for instance, index.html.}
\item{path}{Where to store the saved file. By default, getwd().}
\item{argonPage}{Slot for \link{argonPage}.}
\item{view}{Whether to preview the page in a web browser. TRUE by default.}
}
\description{
Create an HTML version of the argonPage
}
\note{
Do not forget to copy the inst folder of the package to the
root of your website folder.
}
\examples{
if(interactive()){
library(argonR)
# generate the page
example <- argonPage(
title = "ArgonR Static Template",
author = "Somebody",
description = "HTML Static Template",
navbar = argonNavbar(id = "navbar"),
footer = argonFooter(),
# main content
argonSection(),
argonSection(),
argonSection(),
argonSection(),
argonSection()
)
# create the path
path <- getwd()
# generate the static page
argonPageTemplate(filename = "example", path = path, argonPage = example)
}
}
\author{
David Granjon, \email{[email protected]}
}