Go to settings and configure pages, deploy from the branch, and then select the root folder. IF YOU DO NOT DO THIS YOUR PAGE WILL NOT BUILD.
Incase of issues with the user for your repository not being able to be resolved resulting in the page not building do the following: instead of the usual repository: yourNameHere in the repository section write repository: usr/yourNameHere
To name a file, use the following structure (Note that dates should never be in the future and should always be in the format YYYY-MM-DD):
Make sure that notebooks are in the notebook folder and posts are in the posts folder.
For markdown files in _posts:
year-month-day-fileName.md
For jupyter notebooks in _notebooks:
year-month-day-fileName.ipynb
categories: [C1.4] each item in the same category will be lumped together to be seen easily on the tags page. search_exclude: true to the front matter of the page. This will hide the page from appearing when the viewer uses search. image: /images/file.jpg and then the name of the image that you want to use. The image must be in the images folder. Furthermore if you would like the file to not show up on the main page hide: true can be added to the front matter.@import "minima/NIGHTHAWK-Pages-styles";. Note that you can also add your own SCSS in the file itself in area labeled specifically for that purpose. Also you can mix different styles together in NIGHTHAWK-Pages however the effects may vary. {%- include post_list.html -%} Note that the liquid syntax is surrounded by curly braces and percent signs. This can be used anywhere in the repository. layout: [your layout here] Using another pre-existing layout uses the same front matter syntax as defined above. This layout will have to be written in your own custom liquid defining the structure of the page. This site is intended for Students. This is to record plans, complete hacks, and do work for your learnings.
All GitHub Pages websites are managed on GitHub infrastructure. GitHub uses Jekyll to transform your content into static websites and blogs. Each time we change files in GitHub it initiates a GitHub Action that rebuilds and publishes the site with Jekyll.
In all development, it is recommended to test your code before deployment. The GitHub Pages development process is optimized by testing your development on your local machine, prior to files on GitHub
Development Cycle. For GitHub pages, the tooling described below will create a development cycle make-code-save-preview. In the development cycle, it is a requirement to preview work locally, prior to doing a VSCode commit to git.
Deployment Cycle. In the deployment cycle, sync-github-action-review, it is a requirement to complete the development cycle prior to doing a VSCode sync. The sync triggers github repository update. The action starts the jekyll build to publish the website. Any step can have errors and will require you to do a review.
The result of these step is server running on: http://0.0.0.0:4100/teacher/. Regeneration messages will run in terminal on any save. Press the Enter or Return key in the terminal at any time to enter commands.
Complete installation
bundle installRun Server. This requires running terminal commands make, make stop, make clean, or make convert to manage the running server. Logging of details will appear in terminal. A Makefile has been created in project to support commands and start processes.
cd ~/vscode/teacher # my project location, adapt as necessary
makeServer address: http://0.0.0.0:4100/teacher/Save on ipynb or md activiates "regeneration". Refresh browser to see updates. Example terminal message...
Regenerating: 1 file(s) changed at 2023-07-31 06:54:32
_notebooks/2024-01-04-cockpit-setup.ipynbTerminal message are generated from background processes. Click return or enter to obtain prompt and use terminal as needed for other tasks. Alway return to root of project cd ~/vscode/teacher for all "make" actions.
Stop preview server, but leave constructed files in project for your review.
make stopmake cleanmake convertMeta data also known as front matter is a set of key value pairs that can provide additional information to github pages about .md and .ipynb files. This can and probably will be used in other file types (ie doc, pdf), if we added them to the system.
In the front matter you can also define things like a title and description for the page. Additional front matter is defined to place content on "Computer Science Lab Notebook" page. The courses: key will place data on a specific page with the nested week: placing data on a specific row on the page. The type: key in front matter will place blog under the plans, hacks(ToDo), and tangibles column.
In our files the front matter is defined at the top of the page or the first markdown cell.
First open one of the .md or .ipynb files already included in either your _posts|_notebooks folder.
In the .md file you should notice something similar to this at the top of the page. To see this in your .ipynb files you will need to double click the markdown cell at the top of the file.
---
toc: true
comments: false
layout: post
title: Daily Plan Sample
description: Example Blog!!! This shows planning and notes from hacks.
type: plans
courses: { compsci: {week: 0} }
---Front matter will always have '---' at the top and bottom to distinguish it and each key value pair will be separated by a ':'.
Here we can modify things like the title and description.
The type value will tells us which column this is going to appear under, supported values: plans, hacks, tangibles.
The courses tells us which menu item it will be under, in this case the compsci menu, and the week tells it what row (week) it will appear under that menu.
In our examples, hacks(ToDo) contains references to our IPYNB files; these are stored in GitHub under the _notebooks folder. The plans and tangibles contains references to our MD files; these are stored in GitHub under the _posts folder.
compsci.md - this is the "Computer Science Lab Notebook" page and is the link https://nighthawkcoders.github.io/student/compsci. It contains the Title and Number of units on the page._data/compsci.yml - this contains the supporting data that helps organize the units on the page._layouts\schedule.html - this contains code, in the Liquid language, that generates the HTML for all the rows and columns.csa: {week: 0} under courses.