Hello :wave: @aidenhuynh! Thank you for using fastpages!
Before you merge this PR
Create an ssh key-pair. Open this utility. Select: RSA and 4096 and leave Passphrase blank. Click the blue button Generate-SSH-Keys.
Navigate to this link and click New repository secret. Copy and paste the Private Key into the Value field. This includes the "---BEGIN RSA PRIVATE KEY---" and "--END RSA PRIVATE KEY---" portions. In the Name field, name the secret SSH_DEPLOY_KEY.
Navigate to this link and click the Add deploy key button. Paste your Public Key from step 1 into the Key box. In the Title, name the key anything you want, for example fastpages-key. Finally, make sure you click the checkbox next to Allow write access (pictured below), and click Add key to save the key.
What to Expect After Merging This PR
GitHub Actions will build your site, which will take 2-3 minutes to complete. This will happen anytime you push changes to the master branch of your repository. You can monitor the logs of this if you like on the Actions tab of your repo.
Your GH-Pages Status badge on your README will eventually appear and be green, indicating your first successful build.
You can monitor the status of your site in the GitHub Pages section of your repository settings.
If you are not using a custom domain, your website will appear at:
After merging this PR, add a file named CNAME at the root of your repo. For example, the fastpages blog is hosted at https://fastpages.fast.ai, which means our CNAME contains the following contents:
fastpages.fast.ai
Change the url and baseurl parameters in your /_config.yml file to reflect your custom domain.
Wondering how to setup a custom domain? See this article. You must add a CNAME file to the root of your master branch for the intructions in the article to work correctly.
Questions
Please use the nbdev & blogging channel in the fastai forums for any questions or feature requests.
Hello :wave: @aidenhuynh! Thank you for using fastpages!
Before you merge this PR
Create an ssh key-pair. Open this utility. Select:
RSA
and4096
and leavePassphrase
blank. Click the blue buttonGenerate-SSH-Keys
.Navigate to this link and click
New repository secret
. Copy and paste the Private Key into theValue
field. This includes the "---BEGIN RSA PRIVATE KEY---" and "--END RSA PRIVATE KEY---" portions. In theName
field, name the secretSSH_DEPLOY_KEY
.Navigate to this link and click the
Add deploy key
button. Paste your Public Key from step 1 into theKey
box. In theTitle
, name the key anything you want, for examplefastpages-key
. Finally, make sure you click the checkbox next toAllow write access
(pictured below), and clickAdd key
to save the key.What to Expect After Merging This PR
If you are not using a custom domain, your website will appear at:
https://aidenhuynh.github.io/CS_Swag
Optional: Using a Custom Domain
After merging this PR, add a file named
CNAME
at the root of your repo. For example, thefastpages
blog is hosted athttps://fastpages.fast.ai
, which means our CNAME contains the following contents:Change the
url
andbaseurl
parameters in your/_config.yml
file to reflect your custom domain.Wondering how to setup a custom domain? See this article. You must add a CNAME file to the root of your master branch for the intructions in the article to work correctly.
Questions
Please use the nbdev & blogging channel in the fastai forums for any questions or feature requests.