sbcshs-website

This repository contains the source code for the website for Stone Bridge High School's Computer Science Honor Society. 🖥️

Contributing

Setup

To install all dependencies required to build the site, run

pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-glightbox pillow cairosvg

Adding Images

When adding images, upload the file to /overrides/assets/images, then use HTML to add images.

<img src="../assets/images/[image]" alt="[title]" width="[num]" height="[num]" align="[alignment]" loading="eager"/>

If adding images to index.md, change the src attribute to

<img src="assets/images/[image]" />

Refer to the Material for MkDocs documentation to learn more about Material for MkDocs's capabilities.

Setting up VSCode and Github

Install VSCode.

Visit GitHub and make an account. (If you already have an account, skip this step)

Download GitHub Desktop (unless you are familiar with git or other alternatives). Note: If you don't want to/can’t install Desktop and/or VS code, you can do everything within the browser, but you may have limited access. I (Basil) am doing it on the browser and have been able to do everything just the same, though keep in mind that things may go wrong.

Sign into GitHub Desktop using your GitHub account.

Clone the repository.

If VSCode is installed, click the button "Open in Visual Studio Code".

Extras

Extensions:

Live Sass Compiler (recommended): Allows you to compile sass and scss files to css.

Markdownlint (recommended): Provides formatting advice for the markdown language.

Color Highlight: Displays the color of an RGB or hex code value next to the value itself.