Skip to content

github faq

Chris Kamphuis edited this page Mar 3, 2021 · 9 revisions

Github FAQ

Q1: How do I find rendered pages?

You can open the URL, navigate there from the settings or type the URL manually; If your repository has URL https://github.com/rubigdata/bigdata-blog-2021-NoxDecima/ your index.md rendered as index.html can be found at https://rubigdata.github.io/bigdata-blog-2021-NoxDecima/.

Settings screenshot (click on the little wheel icon to get there):

Screenshot from chat


Q2: How do I link between pages on my rendered HTML blog?

Use [anchor text](page.html) to link to a page rendered from page.md. Use relative paths. Do not include /docs/ (unless you modified the Github repo settings to use a branch).


Q3: How do I show images on my rendered HTML blog?

Use [anchor text](image.png) just like linking to a page. Do not include /docs/ (unless you modified the Github repo settings to use a branch). You put the image image.png in your docs folder. For assignment 2 and later, you still put the image in your big-data-2021-name docs folder (do not link from other repositories since it is error prone).


Q4: How do I know if rendering has completed?

After a commit has been pushed, you see the commit hash in the git UI:

Not done screenshot

When rendering by Jekyll has completed, you see a green checkmark in front of the commit hash:

Done screenshot


Q5: How do I run Jekyll?

While you can run Jekyll locally, this is not covered in the course, and not necessary either - Github pages runs Jekyll for you, and also puts the HTML files in the right place. See also FAQ Q1 above.

Feel free to add Q&A pairs

Clone this wiki locally