Tools Verify using Shell

Computers and Terminals
Setup a Personal GitHub Pages Project
Shell Script and Variables
Describing the Outputs of the Variables
Project Setup and Analysis with Bash Scripts
Env, Git, and GitHub
Advanced Shell project
Display Shell commands help using man

Computers and Terminals

A brief overview of Terminal and Linux is a step on your way to becoming a Linux expert. When a computer boots up, a kernel (MacOS, Windows, Linux) is started. This kernel is the core of the operating system and manages hardware resources. Above the kernel, various applications run, including the shell and terminal, which allow users to interact with the system using a basic set of commands provided by the kernel.

Typically, casual users interact with the system through a Desktop User Interface (UI) that is started by the computer’s boot-up processes. However, to interact directly with the shell, users can run a “terminal” application through the Desktop UI. Additionally, VS Code provides the ability to activate a “terminal” within its editing environment, making it convenient for developers to execute commands without leaving the code editor.

In this next phase, we will use a Jupyter notebook to perform Linux commands through a terminal. The Jupyter notebook is an application that runs above the kernel, providing an interactive environment for writing and executing code, including shell commands. This setup allows us to seamlessly integrate code execution, data analysis, and documentation in one place, enhancing our productivity and learning experience.

Setup a Personal GitHub Pages Project

You will be making a personal copy of the course repository. Be sure to have a GitHub account!!!

Use the Green “Use this Template” button on the portfolio_2025 repository page to set up your personal GitHub Pages repository.
Create a new repository.
Fill in the dialog and select the Repository Name to be under your GitHub ID ownership.
After this is complete, use the Green “Code” button on the newly created repository page to capture your “Project Repo” name.

In the next few code cells, we will run a bash (shell) script to pull a GitHub project.

Shell Script and Variables

We will ultimately run a bash (shell) script to pull a GitHub project. This next script simply sets up the necessary environment variables to tell the script the location of repository from GitHub and where to copy the output.

For now, focus on each line that begins with export. These are shell variables. Each line has a name (after the keyword export) and a value (after the equal sign).

Here is a full description:

Creates a temporary file /tmp/variables.sh to store environment variables.
Sets the project_dir variable to your home directory with a subdirectory named nighthawk. You can change nighthawk to a different name to test your git clone.
Sets the project variable to a subdirectory within project_dir named portfolio_2025. You can change portfolio_2025 to the name of your project.
Sets the project_repo variable to the URL of the GitHub repository. Change this to the project you created from the portfolio_2025 template.

By running this script, you will prepare your environment for cloning and working on your GitHub project. This is an essential step in setting up your development environment and ensuring that all dependencies are correctly configured.

%%script bash

# Dependency Variables, set to match your project directories

cat <<EOF > /tmp/variables.sh
export project_dir=/mnt/c/Users/aadit/Documents  # change nighthawk to different name to test your git clone
export project=\$project_dir/aadit_student_2025  # change student_2025 to name of project from git clone
export project_repo="https://github.com/aaguy-hue/aadit_2025.git"  # change to project you created from portfolio_2025 template 
EOF

Describing the Outputs of the Variables

The next script will extract the saved variables and display their values. Here is a description of the commands:

The source command loads the variables that we saved in the /tmp/variables.sh file in the previous code cell.
The echo commands display the contents of the named variables:
- project_dir: The directory where your project is located.
- project: The specific project directory within project_dir.
- project_repo: The URL of the GitHub repository.

By running this script, you can verify that the environment variables are correctly set in your development environment. If they don’t match up, go back to the previous code cell and make the necessary corrections.

%%script bash

# Extract saved variables
source /tmp/variables.sh

# Output shown title and value variables
echo "Project dir: $project_dir"
echo "Project: $project"
echo "Repo: $project_repo"

Project dir: /mnt/c/Users/aadit/Documents
Project: /mnt/c/Users/aadit/Documents/aadit_student_2025
Repo: https://github.com/aaguy-hue/aadit_2025.git

Project Setup and Analysis with Bash Scripts

The bash scripts that follow automate what was done in the Tools Installation procedures with regards to cloning a GitHub project. Doing this in a script fashion adds the following benefits:

After completing these steps, we will have notes on how to set up and verify a project.
By reviewing these commands, you will start to learn the basics of Linux.
By setting up these code cells, you will be learning how to develop automated scripts using Shell programming.
You will learn that pretty much anything we type on a computer can be automated through the use of variables and a coding language.

Pull Code

Pull code from GitHub to your machine. This is a bash script, a sequence of commands, that will create a project directory and add the “project” from GitHub to the vscode directory. There is conditional logic to make sure that the clone only happens if it does not (!) exist. Here are some key elements in this code:

cd command (change directory), remember this from the terminal session.
if statements (conditional statements, called selection statements by College Board), code inside only happens if the condition is met.

Run the script two times and you will see that the output changes. In the second run, the files exist and it impact the flow of the code.

%%script bash

# Extract saved variables
source /tmp/variables.sh

echo "Using conditional statement to create a project directory and project"

cd ~    # start in home directory

# Conditional block to make a project directory
if [ ! -d $project_dir ]
then 
    echo "Directory $project_dir does not exist... making directory $project_dir"
    mkdir -p $project_dir
fi
echo "Directory $project_dir exists." 

# Conditional block to git clone a project from project_repo
if [ ! -d $project ]
then
    echo "Directory $project does not exist... cloning $project_repo"
    cd $project_dir
    git clone $project_repo
    cd ~
fi
echo "Directory $project exists."

Using conditional statement to create a project directory and project
Directory /mnt/c/Users/aadit/Documents exists.
Directory /mnt/c/Users/aadit/Documents/aadit_student_2025 exists.

Look at Files in GitHub Project

All computers contain files and directories. The clone brought more files from the cloud to your machine. Review the bash shell script, observe the commands that show and interact with files and directories. These were used during setup.

ls lists computer files in Unix and Unix-like operating systems.
cd offers a way to navigate and change the working directory.
pwd prints the working directory.
echo is used to display a line of text/string that is passed as an argument.

%%script bash

# Extract saved variables
source /tmp/variables.sh

echo "Navigate to project, then navigate to area wwhere files were cloned"
cd $project
pwd

echo ""
echo "list top level or root of files with project pulled from github"
ls

Navigate to project, then navigate to area wwhere files were cloned
/mnt/c/Users/aadit/Documents/aadit_student_2025

list top level or root of files with project pulled from github
404.html
assets
_config.yml
Gemfile
Gemfile.lock
images
_includes
index.md
_layouts
LICENSE
Makefile
navigation
_notebooks
_posts
README4YML.md
README.md
requirements.txt
_sass
scripts
_site

Look at File List with Hidden and Long Attributes

Most Linux commands have options to enhance behavior. The enhanced listing below shows permission bits, owner of the file, size, and date.

Some useful ls flags:

-a: List all files including hidden files.
-l: List in long format.
-h: Human-readable file sizes.
-t: Sort by modification time.
-R: Reverse the order of the sort.

ls reference

%%script bash

# Extract saved variables
source /tmp/variables.sh

echo "Navigate to project, then navigate to area wwhere files were cloned"
cd $project
pwd

echo ""
echo "list all files in long format"
ls -al   # all files -a (hidden) in -l long listing

Navigate to project, then navigate to area wwhere files were cloned
/mnt/c/Users/aadit/Documents/aadit_student_2025

list all files in long format
total 44
drwxrwxrwx 1 amath amath  4096 Aug 26 12:38 .
drwxrwxrwx 1 amath amath  4096 Aug 26 19:42 ..
-rwxrwxrwx 1 amath amath   461 Aug 21 16:48 404.html
drwxrwxrwx 1 amath amath  4096 Aug 21 16:48 assets
-rwxrwxrwx 1 amath amath   934 Aug 26 12:06 _config.yml
-rwxrwxrwx 1 amath amath   168 Aug 22 12:30 Gemfile
-rwxrwxrwx 1 amath amath  7728 Aug 24 13:19 Gemfile.lock
drwxrwxrwx 1 amath amath  4096 Aug 27  2024 .git
drwxrwxrwx 1 amath amath  4096 Aug 21 16:48 .github
-rwxrwxrwx 1 amath amath   273 Aug 27  2024 .gitignore
drwxrwxrwx 1 amath amath  4096 Aug 21 16:48 images
drwxrwxrwx 1 amath amath  4096 Aug 21 16:48 _includes
-rwxrwxrwx 1 amath amath   239 Aug 22 11:58 index.md
drwxrwxrwx 1 amath amath  4096 Aug 21 16:48 _layouts
-rwxrwxrwx 1 amath amath 11558 Aug 21 16:48 LICENSE
-rwxrwxrwx 1 amath amath  3658 Aug 26 12:06 Makefile
drwxrwxrwx 1 amath amath  4096 Aug 21 16:48 navigation
drwxrwxrwx 1 amath amath  4096 Aug 21 16:48 _notebooks
drwxrwxrwx 1 amath amath  4096 Aug 21 16:48 _posts
-rwxrwxrwx 1 amath amath    86 Aug 21 16:48 README4YML.md
-rwxrwxrwx 1 amath amath 14432 Aug 21 16:48 README.md
-rwxrwxrwx 1 amath amath    62 Aug 21 16:48 requirements.txt
drwxrwxrwx 1 amath amath  4096 Aug 21 16:48 _sass
drwxrwxrwx 1 amath amath  4096 Aug 21 21:54 scripts
drwxrwxrwx 1 amath amath  4096 Aug 26 12:38 _site
drwxrwxrwx 1 amath amath  4096 Aug 26 11:57 .venv
drwxrwxrwx 1 amath amath  4096 Aug 23 12:15 .vscode

%%script bash

# Extract saved variables
source /tmp/variables.sh

echo "Look for posts"
export posts=$project/_posts  # _posts inside project
cd $posts  # this should exist per fastpages
pwd  # present working directory
ls -lR  # list posts recursively

Look for posts
/mnt/c/Users/aadit/Documents/aadit_student_2025/_posts
.:
total 0
drwxrwxrwx 1 amath amath 4096 Aug 26 12:38 Foundation

./Foundation:
total 12
-rwxrwxrwx 1 amath amath 5104 Aug 26 12:38 2024-08-21-sprint1_hacks_IPYNB_2_.md
-rwxrwxrwx 1 amath amath 2843 Aug 26 12:38 2024-08-21-sprint1_plan_IPYNB_2_.md
drwxrwxrwx 1 amath amath 4096 Aug 26 12:38 A-pair_programming
drwxrwxrwx 1 amath amath 4096 Aug 26 12:38 B-tools_and_equipment
-rwxrwxrwx 1 amath amath    0 Aug 26 12:38 toolsSetup.md

./Foundation/A-pair_programming:
total 24
-rwxrwxrwx 1 amath amath  5482 Aug 21 16:48 2023-08-16-pair_programming.md
-rwxrwxrwx 1 amath amath  3242 Aug 26 12:38 2023-08-16-pair_showcase_IPYNB_2_.md
-rwxrwxrwx 1 amath amath 10043 Aug 26 12:38 2023-08-17-pair_habits_IPYNB_2_.md

./Foundation/B-tools_and_equipment:
total 92
-rwxrwxrwx 1 amath amath  8196 Aug 26 12:38 2023-08-19-devops_accounts_IPYNB_2_.md
-rwxrwxrwx 1 amath amath  4949 Aug 26 12:38 2023-08-21-devops_tools-home_IPYNB_2_.md
-rwxrwxrwx 1 amath amath 17367 Aug 26 12:38 2023-08-21-devops_tools-setup_IPYNB_2_.md
-rwxrwxrwx 1 amath amath 16130 Aug 26 12:38 2023-08-22-devops_tools-verify_IPYNB_2_.md
-rwxrwxrwx 1 amath amath 25977 Aug 26 12:38 2023-08-23-devops-githhub_pages-play_IPYNB_2_.md
-rwxrwxrwx 1 amath amath  7506 Aug 26 12:38 2023-08-23-devops-hacks_IPYNB_2_.md

%%script bash

# Extract saved variables
source /tmp/variables.sh

echo "Look for notebooks"
export notebooks=$project/_notebooks  # _notebooks is inside project
cd $notebooks   # this should exist per fastpages
pwd  # present working directory
ls -lR  # list notebooks recursively

Look for notebooks
/mnt/c/Users/aadit/Documents/aadit_student_2025/_notebooks
.:
total 0
drwxrwxrwx 1 amath amath 4096 Aug 26 12:28 Foundation

./Foundation:
total 32
-rwxrwxrwx 1 amath amath 6917 Aug 26 12:37 2024-08-21-sprint1_hacks.ipynb
-rwxrwxrwx 1 amath amath 4141 Aug 21 22:24 2024-08-21-sprint1_plan.ipynb
drwxrwxrwx 1 amath amath 4096 Aug 21 16:48 A-pair_programming
drwxrwxrwx 1 amath amath 4096 Aug 21 16:48 B-tools_and_equipment
-rwxrwxrwx 1 amath amath 8192 Aug 26 12:28 wikipedia_ratings.db

./Foundation/A-pair_programming:
total 16
-rwxrwxrwx 1 amath amath  3983 Aug 21 16:48 2023-08-16-pair_showcase.ipynb
-rwxrwxrwx 1 amath amath 11765 Aug 21 16:48 2023-08-17-pair_habits.ipynb

./Foundation/B-tools_and_equipment:
total 116
-rwxrwxrwx 1 amath amath  9927 Aug 21 16:48 2023-08-19-devops_accounts.ipynb
-rwxrwxrwx 1 amath amath  6025 Aug 21 16:48 2023-08-21-devops_tools-home.ipynb
-rwxrwxrwx 1 amath amath 23399 Aug 21 16:48 2023-08-21-devops_tools-setup.ipynb
-rwxrwxrwx 1 amath amath 23730 Aug 27  2024 2023-08-22-devops_tools-verify.ipynb
-rwxrwxrwx 1 amath amath 32887 Aug 21 16:48 2023-08-23-devops-githhub_pages-play.ipynb
-rwxrwxrwx 1 amath amath  9663 Aug 21 16:48 2023-08-23-devops-hacks.ipynb

%%script bash

# Extract saved variables
source /tmp/variables.sh

echo "Look for images, print working directory, list files"
cd $project/images  # this should exist per fastpages
pwd
ls -lR

Look for images, print working directory, list files
/mnt/c/Users/aadit/Documents/aadit_student_2025/images
.:
total 52
-rwxrwxrwx 1 amath amath 15406 Aug 21 16:48 favicon.ico
-rwxrwxrwx 1 amath amath 34239 Aug 21 16:48 logo.png
drwxrwxrwx 1 amath amath  4096 Aug 21 16:48 notebooks

./notebooks:
total 0
drwxrwxrwx 1 amath amath 4096 Aug 21 16:48 foundation

./notebooks/foundation:
total 364
-rwxrwxrwx 1 amath amath 310743 Aug 21 16:48 create_repo.png
-rwxrwxrwx 1 amath amath  29416 Aug 21 16:48 push.jpg
-rwxrwxrwx 1 amath amath  17105 Aug 21 16:48 stage.jpg
-rwxrwxrwx 1 amath amath   6659 Aug 21 16:48 wsl.jpg

Look inside a Markdown File

“cat” reads data from the file and gives its content as output

%%script bash

# Extract saved variables
source /tmp/variables.sh

echo "Navigate to project, then navigate to area wwhere files were cloned"

cd $project
echo "show the contents of README.md"
echo ""

cat README.md  # show contents of file, in this case markdown
echo ""
echo "end of README.md"

Navigate to project, then navigate to area wwhere files were cloned
show the contents of README.md

# Introduction

Nighthawk Pages is a project designed to support students in their Computer Science and Software Engineering education. It offers a wide range of resources including tech talks, code examples, and educational blogs.

GitHub Pages can be customized by the blogger to support computer science learnings as the student works through the pathway of using Javascript, Python/Flask, Java/Spring.  

## Student Requirements

Del Norte HS students will be required to review their personal GitHub Pages at each midterm and final.  This review will contain a compilation of personal work performed within each significant grading period.

In general, Students and Teachers are expected to use GitHub pages to build lessons, complete classroom hacks, perform work on JavaScript games, and serve as a frontend to full-stack applications.

Exchange of information could be:

1. sharing a file:  `wget "raw-link.ipynb"
2. creating a template from this repository
3. sharing a fork among team members
4. etc.

---

## History

This project is in its 3rd revision (aka 3.0).

The project was initially based on Fastpages. But this project has diverged from those roots into an independent entity.  The decision to separate from Fastpages was influenced by the deprecation of Fastpages by authors.  It is believed by our community that the authors of fastpages turned toward Quatro.  After that change of direction fastpages did not align with the Teacher's goals and student needs. The Nighthawk Pages project has more of a raw development blogging need.

### License

The Apache license has its roots in Fastpages.  Thus, it carries its license forward.  However, most of the code is likely unrecognizable from those roots.

### Key Features

- **Code Examples**: Provides practical coding examples in JavaScript, including a platformer game, and frontend code for user databases using Python and Java backends.
- **Educational Blogs**: Offers instructional content on various topics such as developer tools setup, deployment on AWS, SQL databases, machine learning, and data structures. It utilizes Jupyter Notebooks for interactive lessons and coding challenges.
- **Tools and Integrations**: Features GitHub actions for blog publishing, Utterances for blog commenting, local development support via Makefile and scripts, and styling with the Minima Theme and SASS. It also includes a new integration with GitHub Projects and Issues.

### Contributions

- **Notable Contributions**: Highlights significant contributions to the project, including theme development, search and tagging functionality, GitHub API integration, and the incorporation of GitHub Projects into GitHub pages. Contributors such as Tirth Thakker, Mirza Beg, and Toby Ledder have played crucial roles in these developments.

- **Blog Contributions**:  Often students contribute articles and blogs to this project.  Their names are typically listed in the front matter of their contributing post.

---

## GitHub Pages setup

The absolutes in setup up...

**Activate GitHub Pages Actions**: This step involves enabling GitHub Pages Actions for your project. By doing so, your project will be automatically deployed using GitHub Pages Actions, ensuring that your project is always up to date with the latest changes you push to your repository.

- On the GitHub website for the repository go to the menu: Settings -> Pages ->Build
- Under the Deployment location on the page, select "GitHub Actions".

**Update `_config.yml`**: You need to modify the `_config.yml` file to reflect your repository's name. This configuration is crucial because it ensures that your project's styling is correctly applied, making your deployed site look as intended rather than unstyled or broken.

```text
github_repo: "student_2025" 
baseurl: "/student_2025"
```

**Set Repository Name in Makefile**: Adjust the `REPO_NAME` variable in your Makefile to match your GitHub repository's name. This action facilitates the automatic updating of posts and notebooks on your local development server, improving the development process.

```make
# Configuration, override port with usage: make PORT=4200
PORT ?= 4100
REPO_NAME ?= student_2025
LOG_FILE = /tmp/jekyll$(PORT).log
```

### Tool requirements

All `GitHub Pages` websites are managed on GitHub infrastructure and use GitHub version control.  Each time we change files in GitHub it initiates a GitHub Action, a continuous integration and development toolset, that rebuilds and publishes the site with Jekyll.  

- GitHub uses `Jekyll` to transform your markdown and HTML content into static websites and blogs. [Jekyll](https://jekyllrb.com/).
- A Linux shell is required to work with this project integration with GitHub Pages, GitHub and VSCode.  Ubuntu is the preferred shell, though MacOS shell is supported as well.  There will be some key setup scripts that follow in the README.
- Visual Studio Code is the Nighthawk Pages author's preferred code editor and extensible development environment.  VSCode has a rich ecosystem of developer extensions that ease working with GitHub Pages, GitHub, and many programming languages.  Setting up VSCode and extensions will be elaborated upon in this document.
- An anatomy section in this README will describe GitHub Pages and conventions that are used to organize content and files.  This includes file names, key coding files, metadata tagging of blogs, styling tooling for blogs, etc.

### Development Environment Setup

Comprehensive start. A topic-by-topic guide to getting this project running is published [here](https://nighthawkcoders.github.io/portfolio_2025/devops/tools/home).

Quick start.  A quick start below is a reminder, but is dependent on your knowledge.  Only follow this instruction if you need a refresher.  Always default to the comprehensive start if any problem occurs.

#### Clone Repo

Run these commands to obtain the project, then locate into the project directory with the terminal, install an extensive set of tools, and make.

```bash
git clone <this-repo> # git clone https://github.com/nighthawkcoders/student_2025.git 
cd <repo-dir>/scripts # cd student_2025
```

#### Windows WSL and/or Ubuntu Users

- Execute the script: `./activate_ubuntu.sh`

#### macOS Users

- Execute the script: `./activate_macos.sh`

#### Kasm Cloud Desktop Users

- Execute the script: `./activate.sh`

## Run Server on localhost

To preview the project you will need to "make" the project.

### Bundle install

The very first time you clone run project you will need to run this Ruby command as the final part of your setup.

```bash
bundle install
```

### Start the 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 the terminal.   A `Makefile` has been created in the project to support commands and start processes.

Start the server, this is the best choice for initial and iterative development.  Note. after the initial `make`, you should see files automatically refresh in the terminal on VSCode save.

  ```bash
  make
  ```

### Load web application into the Browser

Start the preview server in the terminal,
The terminal output from `make` shows the server address. "Cmd" or "Ctl" click the http location to open the preview server in a browser. Here is an example Server address message, click on the Server address to load:...

  ```text
  http://0.0.0.0:4100/student_2025/
  ```

### Regeneration of web application

Save on ".ipynb" or ".md" file activiates "regeneration". An example terminal message is below.  Refresh the browser to see updates after the message displays.

  ```text
  Regenerating: 1 file(s) changed at 2023-07-31 06:54:32
      _notebooks/2024-01-04-cockpit-setup.ipynb
  ```

### Other "make" commands

Terminal messages are generated from background processes.  At any time, click return or enter in a terminal window to obtain a prompt.  Once you have the prompt you can use the terminal as needed for other tasks.  Always return to the root of project `cd ~/vscode/student_2025` for all "make" actions.

#### Stop the preview server

Stopping the server ends the web server applications running process.  However, it leaves constructed files in the project in a ready state for the next time you run `make`.

  ```bash
  make stop
  ```

### Clean the local web application environment

This command will top the server and "clean" all previously constructed files (ie .ipynb -> .md). This is the best choice when renaming files has created duplicates that are visible when previewing work.

  ```bash
  make clean
  ```

### Observe build errors

Test Jupyter Notebook conversions (ie .ipynb -> .md), this is the best choice to see if an IPYNB conversion error is occurring.

  ```bash
  make convert
  ```

---

## Development Support

### File Names in "_posts", "_notebooks"

There are two primary directories for creating blogs.  The "_posts" directory is for authoring in markdown only.  The "_notebooks" allows for markdown, pythons, javascript and more.

To name a file, use the following structure (If dates are in the future, review your config.yml setting if you want them to be viewed).  Review these naming conventions.

- For markdown files in _posts:
  - year-month-day-fileName.md
    - GOOD EXAMPLE: 2021-08-02-First-Day.md
    - BAD EXAMPLE: 2021-8-2-first-day.md
    - BAD EXAMPLE: first-day.md
    - BAD EXAMPLE: 2069-12-31-First-Day.md

- For Jupyter notebooks in _notebooks:
  - year-month-day-fileName.ipynb
    - GOOD EXAMPLE: 2021-08-02-First-Day.ipynb
    - BAD EXAMPLE: 2021-8-2-first-day.ipynb
    - BAD EXAMPLE: first-day.ipynb
    - BAD EXAMPLE: 2069-12-31-First-Day.ipynb

### Tags

Tags are used to organize pages by their tag the way to add tags is to add the following to your front matter such as the example seen here `categories: [Tools]` Each item in the same category will be lumped together to be seen easily on the search page.

### Search

All pages can be searched for using the built-in search bar. This search bar will search for any word in the title of a page or in the page itself. This allows for easily finding pages and information that you are looking for. However, sometimes this may not be desirable so to hide a page from the search you need to add `search_exclude: true` to the front matter of the page. This will hide the page from appearing when the viewer uses search.

### Navigation Bar

To add pages to the top navigation bar use _config.yml to order and determine which menus you want and how to order them.  Review the_config.yml in this project for an example.

### Blog Page

There is a blog page that has options for images and a description of the page. This page can help the viewer understand what the page is about and what they can expect to find on the page. The way to add images to a page is to have the following front matter `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 blog page `hide: true` can be added to the front matter.

### SASS support

NIGHTHAWK Pages support a variety of different themes that are each overlaid on top of minima. To use each theme, go to the "_sass/minima/custom-styles.scss" file and simply comment or uncomment the theme you want to use.

To learn about the minima themes search for "GitHub Pages minima" and review the README.

To find a new theme search for "Github Pages Themes".

### Includes

- Nighthawk Pages uses liquid syntax to import many common page elements that are present throughout the repository. These common elements are imported from the _includes directory. If you want to add one of these common elements, use liquid syntax to import the desired element to your file. Here’s an example of the liquid syntax used to import: `<h3>
<a class="post-link" href="">

</a>

</h3><p class="post-meta"></p> ` Note that the liquid syntax is surrounded by curly braces and percent signs. This can be used anywhere in the repository.

### Layouts

- To use or create a custom page layout, make an HTML page inside the _layouts directory, and when you want to use that layout in a file, use the following front matter `layout: [your layout here]`.  All layouts will be written in liquid to define the structure of the page.

### Metadata

Metadata, 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 add 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 the "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 the blog under the plans, hacks(ToDo), and tangibles columns.

- 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.

  ```yaml
  ---
  toc: true
  comments: true
  layout: post
  title: Jupyter Python Sample
  description: Example Blog!!!  This shows code and notes from hacks.
  type: ccc
  courses: { csa: {week: 5} }
  ---
  ```

- The 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 tell us which column this is going to appear under the time box supported pages.  The "ccc" stands for Code, Code, Code.

- The courses will tell us which menu item it will be under, in this case, the `csa` menu, and the `week` tells it what row (week) it will appear under that menu.

end of README.md

Env, Git, and GitHub

Env(ironment) is used to capture things like the path to the Code or Home directory. Git and GitHub are not only used to exchange code between individuals but are also often used to exchange code through servers, in our case for website deployment. All tools we use have behind-the-scenes relationships with the system they run on (MacOS, Windows, Linux) or a relationship with servers to which they are connected (e.g., GitHub). There is an “env” command in bash. There are environment files and setting files (e.g., .git/config) for Git. They both use a key/value concept.

env shows settings for your shell.
git clone sets up a directory of files.
cd $project allows the user to move inside that directory of files.
.git is a hidden directory that is used by Git to establish a relationship between the machine and the Git server on GitHub.

%%script bash

# This command has no dependencies

echo "Show the shell environment variables, key on left of equal value on right"
echo ""

env

Show the shell environment variables, key on left of equal value on right

SHELL=/bin/bash
WSL2_GUI_APPS_ENABLED=1
WSL_DISTRO_NAME=kali-linux
NAME=Aaditlaptop
PWD=/mnt/c/Users/aadit/Documents/aadit_student_2025/_notebooks/Foundation/B-tools_and_equipment
LOGNAME=amath
XAUTHORITY=/home/amath/.Xauthority
HOME=/home/amath
LANG=en_US.UTF-8
WSL_INTEROP=/run/WSL/1061_interop
WAYLAND_DISPLAY=wayland-0
TERM=xterm-256color
USER=amath
DISPLAY=:0
SHLVL=1
XDG_RUNTIME_DIR=/mnt/wslg/runtime-dir
WSLENV=
PATH=/home/amath/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/usr/lib/wsl/lib:/mnt/c/Users/aadit/Documents/aadit_student_2025/.venv/Scripts:/mnt/c/Program Files/Common Files/Oracle/Java/javapath:/mnt/c/Program Files (x86)/Common Files/Oracle/Java/javapath:/mnt/c/Program Files (x86)/VMware/VMware Workstation/bin/:/mnt/c/Windows/system32:/mnt/c/Windows:/mnt/c/Windows/System32/Wbem:/mnt/c/Windows/System32/WindowsPowerShell/v1.0/:/mnt/c/Windows/System32/OpenSSH/:/mnt/c/Program Files/Docker/Docker/resources/bin:/mnt/c/Program Files/dotnet/:/mnt/c/Program Files/Git/cmd:/mnt/c/Program Files (x86)/nodejs/:/mnt/c/ProgramData/chocolatey/bin:/mnt/c/ProgramData/anaconda3/Scripts:/mnt/c/ProgramData/anaconda3:/mnt/c/Program Files/Go/bin:/mnt/c/Users/aadit/AppData/Local/Microsoft/WindowsApps:/mnt/c/Users/aadit/AppData/Local/Programs/Microsoft VS Code/bin:/mnt/c/Users/aadit/AppData/Local/Android/Sdk:/mnt/c/Users/aadit/AppData/Roaming/npm:/mnt/c/Users/aadit/AppData/Local/Android/Sdk/platform-tools:/mnt/c/Users/aadit/AppData/Roaming/Python/Python311/Scripts:/mnt/c/Users/aadit/go/bin
HOSTTYPE=x86_64
PULSE_SERVER=unix:/mnt/wslg/PulseServer
_=/usr/bin/env

%%script bash

# Extract saved variables
source /tmp/variables.sh

cd $project

echo ""
echo "show the secrets of .git config file"
cd .git
ls -l config

echo ""
echo "look at config file"
cat config

show the secrets of .git config file
-rwxrwxrwx 1 amath amath 343 Aug 21 17:15 config

look at config file
[core]
	repositoryformatversion = 0
	filemode = false
	bare = false
	logallrefupdates = true
	symlinks = false
	ignorecase = true
[remote "origin"]
	url = https://github.com/aaguy-hue/aadit_student_2025.git
	fetch = +refs/heads/*:refs/remotes/origin/*
[branch "main"]
	remote = origin
	merge = refs/heads/main
	vscode-merge-base = origin/main

Advanced Shell project

This example was requested by a student (Jun Lim, CSA). The request was to make a Jupyter file using bash; I adapted the request to markdown. This type of thought will have great extrapolation to coding and possibilities of using Lists, Arrays, or APIs to build user interfaces. JavaScript is a language where building HTML is very common.

To get more interesting output from the terminal, this will require using something like mdless (https://github.com/ttscoff/mdless). This enables seeing markdown in rendered format.

On Desktop Install PKG from MacPorts

In Terminal on MacOS

Install ncurses

gem install mdless

Output of the example is much nicer in “Jupyter”

This is starting the process of documentation.

%%script bash

# This example has an error in VSCode; it runs best on Jupyter
cd /tmp

file="sample.md"
if [ -f "$file" ]; then
    rm $file
fi

# Create a markdown file using tee and here document (<<EOF)
tee -a $file >/dev/null <<EOF
# Show Generated Markdown
This introductory paragraph and this line and the title above are generated using tee with the standard input (<<) redirection operator.
- This bulleted element is still part of the tee body.
EOF

# Append additional lines to the markdown file using echo and redirection (>>)
echo "- This bulleted element and lines below are generated using echo with standard output (>>) redirection operator." >> $file
echo "- The list definition, as is, is using space to separate lines. Thus the use of commas and hyphens in output." >> $file

# Define an array of actions and their descriptions
actions=("ls,list-directory" "cd,change-directory" "pwd,present-working-directory" "if-then-fi,test-condition" "env,bash-environment-variables" "cat,view-file-contents" "tee,write-to-output" "echo,display-content-of-string" "echo_text_>\$file,write-content-to-file" "echo_text_>>\$file,append-content-to-file")

# Loop through the actions array and append each action to the markdown file
for action in ${actions[@]}; do
  action=${action//-/ }  # Convert dash to space
  action=${action//,/: } # Convert comma to colon
  action=${action//_text_/ \"sample text\" } # Convert _text_ to "sample text", note escape character \ to avoid "" having meaning
  echo "    - ${action//-/ }" >> $file  # Append action to file
done

echo ""
echo "File listing and status"
ls -l $file # List file details
wc $file   # Show word count
mdless $file  # Render markdown from terminal (requires mdless installation)

rm $file  # Clean up temporary file

File listing and status
-rw-r--r-- 1 amath amath 808 Aug 26 22:40 sample.md
 15 132 808 sample.md


[0;37m[0;1;90;47mShow Generated Markdown [0;2;30;47m======================================================[0;37m

[0;37mThis introductory paragraph and this line and the title above are generated using tee with the standard input (<<) redirection operator.[0;37m

 [0;1;91m* [0;97mThis bulleted element is still part of the tee body.[0;37m
 [0;1;91m* [0;97mThis bulleted element and lines below are generated using echo with standard output (>>) redirection operator.[0;37m
 [0;1;91m* [0;97mThe list definition, as is, is using space to separate lines. Thus the use of commas and hyphens in output.
   [0;1;91m* [0;97mls: list directory[0;97m
   [0;1;91m* [0;97mcd: change directory[0;97m
   [0;1;91m* [0;97mpwd: present working directory[0;97m
   [0;1;91m* [0;97mif then fi: test condition[0;97m
   [0;1;91m* [0;97menv: bash environment variables[0;97m
   [0;1;91m* [0;97mcat: view file contents[0;97m
   [0;1;91m* [0;97mtee: write to output[0;97m
   [0;1;91m* [0;97mecho: display content of string[0;97m
   [0;1;91m* [0;97mecho "sample text" >$file: write content to file[0;97m
   [0;1;91m* [0;97mecho "sample text" >>$file: append content to file[0;97m[0;37m

[0m

Display Shell commands help using `man`

The previous example used a markdown file to store a list of actions and their descriptions. This example uses the man command to generate a markdown file with descriptions of the commands. The markdown file is then displayed using mdless.

In coding, we should try to get data from the content creators instead of creating it on our own. This approach has several benefits:

Accuracy: Descriptions from man pages are authoritative and accurate, as they come directly from the documentation provided by the command’s developers.
Consistency: Automatically generating descriptions ensures consistency in formatting and terminology.
Efficiency: It saves time and effort, especially when dealing with a large number of commands.
Up-to-date Information: man pages are regularly updated with the latest information, ensuring that the descriptions are current.

%%script bash

# This example has an error in VSCode; it runs best on Jupyter
cd /tmp

file="sample.md"
if [ -f "$file" ]; then
    rm $file
fi

# Set locale to C to avoid locale-related errors
export LC_ALL=C

# Create a markdown file using tee and here document (<<EOF)
tee -a $file >/dev/null <<EOF
# Show Generated Markdown
This introductory paragraph and this line and the title above are generated using tee with the standard input (<<) redirection operator.
- This bulleted element is still part of the tee body.
EOF

# Append additional lines to the markdown file using echo and redirection (>>)
echo "- This bulleted element and lines below are generated using echo with standard output (>>) redirection operator." >> $file
echo "- The list definition, as is, is using space to separate lines. Thus the use of commas and hyphens in output." >> $file

# Define an array of commands
commands=("ls" "cat" "tail" "pwd" "env" "grep" "awk" "sed" "curl" "wget")

# Loop through the commands array and append each command description to the markdown file
for cmd in ${commands[@]}; do
  description=$(man $cmd | col -b | awk '/^NAME/{getline; print}')
  echo "    - $description" >> $file
done

echo ""
echo "File listing and status"
ls -l $file # List file details
wc $file   # Show word count
mdless $file  # Render markdown from terminal (requires mdless installation)

rm $file  # Clean up temporary file

troff:<standard input>:1039: warning [p 9, 0.2i]: cannot adjust line
troff:<standard input>:1296: warning [p 11, 5.2i]: cannot adjust line
troff:<standard input>:526: warning [p 9, 5.2i]: cannot break line
troff:<standard input>:2225: warning [p 36, 9.0i]: cannot adjust line
troff:<standard input>:2273: warning [p 37, 5.0i]: cannot adjust line
troff:<standard input>:2572: warning [p 42, 3.2i]: cannot break line



File listing and status
-rw-r--r-- 1 amath amath 1021 Aug 26 22:40 sample.md
  15  160 1021 sample.md


[0;37m[0;1;90;47mShow Generated Markdown [0;2;30;47m======================================================[0;37m

[0;37mThis introductory paragraph and this line and the title above are generated using tee with the standard input (<<) redirection operator.[0;37m

 [0;1;91m* [0;97mThis bulleted element is still part of the tee body.[0;37m
 [0;1;91m* [0;97mThis bulleted element and lines below are generated using echo with standard output (>>) redirection operator.[0;37m
 [0;1;91m* [0;97mThe list definition, as is, is using space to separate lines. Thus the use of commas and hyphens in output.
   [0;1;91m* [0;97mls - list directory contents[0;97m
   [0;1;91m* [0;97mcat - concatenate files and print on the standard output[0;97m
   [0;1;91m* [0;97mtail - output the last part of files[0;97m
   [0;1;91m* [0;97mpwd - print name of current/working directory[0;97m
   [0;1;91m* [0;97menv - run a program in a modified environment[0;97m
   [0;1;91m* [0;97mgrep,  egrep,  fgrep,  rgrep  -    print  lines  that match[0;97m
   [0;1;91m* [0;97mmawk - pattern scanning and text processing language[0;97m
   [0;1;91m* [0;97msed - stream editor for filtering and transforming text[0;97m
   [0;1;91m* [0;97mcurl - transfer a URL[0;97m
   [0;1;91m* [0;97mWget - The non-interactive network downloader.[0;97m[0;37m

[0m