Skip to content

Week 01: Webpage Design

1. HTML Codes

Document Structure

Headings

Divisions & Selections

Text Formatting

Comments & Special Characters

Lists

Links & Images

Media

Tables

Example Tables

Forms

Complete Example 1/2

Complete Example 2/2

Markdown Cheatsheet

This cheatsheet was given to our class by Dr. Taylor.

Markdown 1

Markdown 2

Markdown 3

Markdown 4

Markdown 5

Find out how to change website settings with MKDocs Materials here: MkDocs Material Setup

Problems

  1. Why can I type the same code and get different results? In this image you will see my code for inserting the 10 min Blender Cat. I changed the alt name of the top code right before taking the screen shot, but it showed the image when they were both named the same.

Same code, different results

I had the little image symbol show up before when I was linking a document that was not an acceptable image. A pdf or heic.

  1. My site was broken because I had been writing raw HTML files, but the GitLab CI pipeline expects an MkDocs-based site. The pipeline kept failing because it couldn't build my HTML files with mkdocs build.

    Mr. Dubick and Claude (AI) reviewed all of my original work and migrated everything into a clean, working MkDocs Material site. This involved:

    • Converting all my HTML pages into Markdown (.md) files
    • Setting up a proper mkdocs.yml configuration with the Material theme
    • Creating a .gitlab-ci.yml file so the pipeline knows how to build the site
    • Adding a requirements.txt with the correct Python packages
    • Preserving all my original content, images, and the SVG comic strip
    • Redacting private SSH keys that had been accidentally committed in a terminal log

    Then on my computer, Claude helped me clear out the old broken files, copy in the new MkDocs site, and push everything to GitLab. The pipeline passed and the site went live.