class-code/cyberclassStructured online cybersecurity curriculum for educators, providing ready-to-use activities and resources to teach teens (13-18) about security concepts, threats, and responsible digital practices.
This repository contains educational resources for Class'Code CyberClass.
📦CyberClass # ------------------------------------ Root directory
┣ 📂docs # --------------------------------------- Website sources
┃ ┣ 📂assets # ----------------------------------- General assets (logo, favicon, etc)
┃ ┣ 📂Partie1 # ---------------------------------- Folder for the first module
┃ ┃ ┣ 📜Activite1.en.md # ------------------------ page content file in english of activite 1
┃ ┃ ┣ 📜Activite1.md # --------------------------- page content file of activite 1
┃ ┃ ┣ 📜Activite2.en.md # ------------------------ page content file in english of activite 2
┃ ┃ ┣ 📜Activite2.md # --------------------------- page content file of activite 2
┃ ┃ ┣ 📜index.en.md # ---------------------------- page of introduction in english
┃ ┃ ┣ 📜index.md # ------------------------------- page of introduction (overridden by home.html)
┃ ┃ ┗ 📜.pages # --------------------------------- Navigation links config
┣ 📂overrides # ---------------------------------- Custom pages overrides
┃ ┣ 📜home.en.html # ----------------------------- Homepage override in english
┃ ┗ 📜home.html # -------------------------------- Homepage override
┣ 📜.gitignore # --------------------------------- Git ignored files
┣ 📜README.md # ---------------------------------- Main readme file (This file you're reading)
┗ 📜mkdocs.yml # --------------------------------- Website main config file
To preview the website locally on your computer you need to install python, mkdocs and git.
Prerequisites :
.pkgfor MacOS for convenience)pip install mkdocs-material mkdocs-pdf-export-plugin mkdocs-jupyter mkdocs-macros-plugin mkdocs-awesome-pages-plugin
In a terminal :
git clone https://class-code.gitlab.io/CyberClass/cd CyberClassmkdocs serveAfter a few seconds, the website should be available at : http://localhost:8000