The official rOpenSci docs server which we announced in June is fully ready for production now. Our server automatically builds and hosts pkgdown sites for all ropensci packages.
If all seems good, we strongly suggest to add the URL to the package DESCRIPTION file and include this in the next CRAN update. This has two major benefits:
Pkgdown does automatic cross-linking to other pkgdown sites that can be found via CRAN. This means that if another package refers to your package in an example or vignette, their pkgdown site automatically hyperlinks those functions to your pkgdown site (if your pkgdown URL has been published on CRAN!)
Because all our documentation is hosted under docs.ropensci.org this will accumulate a higher pagerank than when a site are hosted on various custom domains. This should make it easier to find these documentation sites on Google and other search engines.
We hope that this service will make it easy to maintain high quality and visible documentation for your packages! If something is unclear or not working, feel free to ask questions here or on slack.
FAQ
1. What do I need to do to maintain documentation at docs.ropensci.org?
Absolutely nothing, everything is done automatically.
2. How can I customize my docs.ropensci.org site?
You can use all standard pkgdown options in your pkgdown.yml file, except for the template (we use the rotemplate pkgdown theme to render).
4. Why are the images from the readme.md not showing in my pkgdown site?
pkgdown only supports local images in a few locations since only a few locations also work with CRAN's rendering of readme's. The recommended path for static images is man/figures.
5. I already had a site. How to create a redirect from my old pkgdown site?
Simply push an index.html file to your gh-pages branch which redirects to the new site, see for example here.
Hello from rOpenSci!
The official rOpenSci docs server which we announced in June is fully ready for production now. Our server automatically builds and hosts pkgdown sites for all ropensci packages.
If all seems good, we strongly suggest to add the URL to the package DESCRIPTION file and include this in the next CRAN update. This has two major benefits:
docs.ropensci.orgthis will accumulate a higher pagerank than when a site are hosted on various custom domains. This should make it easier to find these documentation sites on Google and other search engines.We hope that this service will make it easy to maintain high quality and visible documentation for your packages! If something is unclear or not working, feel free to ask questions here or on slack.
FAQ
1. What do I need to do to maintain documentation at docs.ropensci.org?
Absolutely nothing, everything is done automatically.
2. How can I customize my docs.ropensci.org site?
You can use all standard pkgdown options in your
pkgdown.ymlfile, except for the template (we use the rotemplate pkgdown theme to render).3. Can I help to improve the template?
Of course! You can send pull requests to ropensci/rotemplate.
4. Why are the images from the readme.md not showing in my pkgdown site?
pkgdown only supports local images in a few locations since only a few locations also work with CRAN's rendering of readme's. The recommended path for static images is
man/figures.5. I already had a site. How to create a redirect from my old pkgdown site?
Simply push an
index.htmlfile to yourgh-pagesbranch which redirects to the new site, see for example here.