wincowgerDEV / OpenSpecy-package

Analyze, Process, Identify, and Share, Raman and (FT)IR Spectra
http://wincowger.com/OpenSpecy-package/
Creative Commons Attribution 4.0 International
23 stars 11 forks source link

add packagedown documentation #126

Closed wincowgerDEV closed 1 year ago

wincowgerDEV commented 1 year ago

Using packagedown to build a nice-looking website and vignettes for the package.

wincowgerDEV commented 1 year ago

To get the images to work correctly, you cannot have any spaces in the file paths of where the folder with the package is located on your computer.

wincowgerDEV commented 1 year ago

Useful https://pkgdown.r-lib.org/articles/how-to-update-released-site.html

wincowgerDEV commented 1 year ago

Issue with local building not being pushed up to the web for some reason. https://stackoverflow.com/questions/69507610/unable-to-push-package-website-pkgdown-from-r-to-github

wincowgerDEV commented 1 year ago

This is a bit of a hack now and shouldn't be merged because I am committing the entire docs folder. Unless we can ignore the docs folder when we push to cran. Currently hosted at http://wincowger.com/OpenSpecy-package. We can change the domain to something else if we would like. I currently own openspecy.com or we could use the default github domain I think.

wincowgerDEV commented 1 year ago

This is a bit of a hack now and shouldn't be merged because I am committing the entire docs folder. Unless we can ignore the docs folder when we push to cran. Currently hosted at http://wincowger.com/OpenSpecy-package. We can change the domain to something else if we would like. I currently own openspecy.com or we could use the default github domain I think.

Actually probably fine because we have already Rbuildignored that directory.

wincowgerDEV commented 1 year ago

Merging so that I can more quickly deploy.