seankross / postcards

💌 Create simple, beautiful personal websites and landing pages using only R Markdown.
Other
551 stars 87 forks source link

How to deploy postcard-webpage to Github Pages #13

Closed joshpersi closed 3 years ago

joshpersi commented 3 years ago

Hi, love the package! I'm having trouble deploying my postcard webpage through GitHub pages. It's not clear to me how I upload my .HTML or .Rmd file (e.g. do I simply add the appropriate file to my repository or do I need to somehow replace the HTML code autogenerated by GitHub pages?).

I looked at the GitHub Pages documentation but still couldn't figure it out. Any help would be greatly appreciated!

ahcyip commented 3 years ago

I believe the missing instruction that should be somewhere here is "rename your knitted html file index.html in your abc.github.io directory"

joshpersi commented 3 years ago

That fixed it! Thanks @ahcyip!

ahcyip commented 3 years ago

@seankross I didn't see it in the help/documentation either and I only knew to rename it index.html from old HTML/Geocities experience :) Has it been added?

ahcyip commented 3 years ago

I added a suggested instruction on the readme here: https://github.com/seankross/postcards/pull/15

ahcyip commented 3 years ago

Hi, love the package! I'm having trouble deploying my postcard webpage through GitHub pages. It's not clear to me how I upload my .HTML or .Rmd file (e.g. do I simply add the appropriate file to my repository or do I need to somehow replace the HTML code autogenerated by GitHub pages?).

I looked at the GitHub Pages documentation but still couldn't figure it out. Any help would be greatly appreciated!

Just a note: I checked the instructions on pages.github.io again and one of the steps does say:

Create an index file Grab your favorite text editor and add an index.html file to your project:

So the complete instructions from template -> html creation -> user.github.io are all there :)