To build the website:
- Make sure you have the most up-to-date version of the
DESCRIPTION
file and the.Rd
files created from ArchR when the package is build. TheDESCRIPTION
file should be copied into the main folder of this repository. The.Rd
files contain the function documentation and should be copied into/man/
. - In the
DESCRIPTION
file, add the following tag "URL: https://www.ArchRProject.com" - You must have pandoc installed.
- You must have the
pkgdown
R library installed. - In R, from the main repository directory (containing the index.md file), run
build_site()
. This will create a lot of HTML files in the/docs/
folder.
To build the book:
Once you've build the book, copy all of the HTML files and required figures etc. into the /docs/bookdown/
folder