diff --git a/TEMPLATE_README.md b/TEMPLATE_README.md index 4492965..6b1905d 100644 --- a/TEMPLATE_README.md +++ b/TEMPLATE_README.md @@ -3,7 +3,7 @@ Some quick modifications for MK docs and teaching - Current mk-docs material version 7.1.7 - + - Updated Mkdocs mateiral is 8.3.9 Main Docs can be found here @@ -46,3 +46,6 @@ Merge made by the 'recursive' strategy. - Material 7.x Introduced dark mode toggle, So this has been removed. - Added Analytics script section for probable plausible integrations. + - Version 1.0 + - Removed my boilerplate text for how the docs work etc. This is now a subrepo. Ask if you want a copy. + diff --git a/custom_theme/partials/copyright.html b/custom_theme/partials/copyright.html new file mode 100644 index 0000000..77661e8 --- /dev/null +++ b/custom_theme/partials/copyright.html @@ -0,0 +1,23 @@ +{#- + This file was automatically generated - do not edit +-#} +
+ {% if config.copyright %} +
+ {{ config.copyright }} +
+ {% endif %} + +
+ Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License. +
+ + {% if not config.extra.generator == false %} + Made with + + Material for MkDocs + + {% endif %} + + +
diff --git a/docs/guides/DockerGuide.md b/docs/guides/DockerGuide.md deleted file mode 100644 index 749afcb..0000000 --- a/docs/guides/DockerGuide.md +++ /dev/null @@ -1,255 +0,0 @@ -# Docker Guide and QRC - -In this section we will have a quick run through of the core docker commands. - -Docker has some [official docs](https://docs.docker.com/get-started/) on this -too. - -## What is Docker - -Docker is a containerisation technology. It allows us to create *sandboxed* -processes, (with their own filesystems) on our computers. -The processes run on-top of our native filesystem, and make use of its core -functionality but give the illusion of being a separate system - - -These sandboxed processes contain everything that is needed to run the -application. - -We misuse docker to create lightweight VMs with examples for you to play with. -It means that I can distribute tasks in an easy way, as everyone should have -exactly the same setup. Additionally, as the images make use of existing OS -functionality, they are pretty lightweight. Linux distros, on the other hand -are getting fatter (you are looking at around 2GB minimal installs now) - -This means you only need to grab a few hundred MB of docker image, rather than a -whole new VM each time. - - -!!! note - - While docker is pretty amazing, there are a few things it cant do. - As we share the same OS, things like kernel-level exploits are hard to do. - Additionally, networking functionality (so stuff like firewalls), - is also shared with the host, so becomes difficult. - - However, for about 90% of what we need, it's going to be more efficient. - -## Terminology - -Image -: A Docker image is the sandbox that contains our filesystem and programs. I - like to think of them as the equivalent of an ISO file - -Container -: A container is a running instance of an *image*. We can have multiple -containers, each based on the same image, which can let us scale applications -(although this isn't really applicable here). - -Stack -: A group of containers running together to serve a purpose. This is a - really nifty thing as it can let us plumb together groups of containers and make - them appear like a single VM. For example, we can combine images for a Webserver, - and database into one seamless system. - -## Docker-Compose - -While we can use low level docker commands (see below) to start and stop -containers, or manage the running docker processes. I intend to make use of -docker-compose. - -Docker-Compose is a system that allows us to specify a "recipe" for running -docker containers. For example, specifying which images to start, what port they -should listen on and other information. It also allows us to group images -together into a stack. - -Docker compose makes use of compose files ```docker-compose.yml``` that contain -the instructions for building the stack. - -!!! tip "Multiple Compose Files" - - If we need to deal with multiple compose files, you have two options - - - Call them different names and tell compose what one to run using the ```-f``` flag - - Put them in different directories - - I prefer the second approach. Compose will also build its images based on the dir - you are working in, so it simplifies image management. - -### Starting and stopping compose-based services - -To start a compose based service ```docker-compose up``` - -``` -dang@DESKTOP-KJDVQ2J:~/6005/6005-CW-Koala$ docker-compose up -Starting 6005-cw-koala_pyramid_1 ... done -Attaching to 6005-cw-koala_pyramid_1 -``` - -!!! important "It's not hung" - - Docker will continue to run in the background, so it will look like the system - has hung. (In the case of some images it may display logging information) - - You will need a new window to interact with the system. - -To Stop a compose based service you need to do two things. - - - If docker is running in the foreground, stop it with ctrl-c - - ```docker-compose down``` - -``` -# Stop the Container Running -^CGracefully stopping... (press Ctrl+C again to force) -Stopping webtrainer_database_1 ... done -Stopping webtrainer_web_1 ... done - -# Remove from Container List -dang@DESKTOP-KJDVQ2J:~/6005/webtrainer$ docker-compose down -Removing webtrainer_database_1 ... done -Removing webtrainer_web_1 ... done -Removing network webtrainer_main_network -``` - -## Low-Level Docker access. - -If we are not using compose we also have the option to deal with docker -directly. - -### Starting and Stopping containers - -### Container Management - -You may also want to examine the currently running containers - -To list containers that are currently running you can use ```docker ps``` - -``` -dang@DESKTOP-KJDVQ2J:~$ docker ps -a -CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES -``` - -To list all containers (including those that are stopped) ```docker ps -a``` - -``` -dang@DESKTOP-KJDVQ2J:~$ docker ps -a -CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES -e4a8e2d38bdb 6005-cw-koala_pyramid "pserve production.i…" 2 weeks ago Exited (137) 2 weeks ago 6005-cw-koala_pyramid_1 -8cefe7adba95 7024cem/webdb "docker-entrypoint.s…" 4 weeks ago Exited (255) 2 weeks ago 0.0.0.0:3306->3306/tcp, 33060/tcp webtrainer_database_1 -e7d7e6005693 7024cem/webtrainer "docker-php-entrypoi…" 4 weeks ago Exited (255) 2 weeks ago 0.0.0.0:80->80/tcp webtrainer_web_1 -6f3bbd7104c7 7024cem/webdb "docker-entrypoint.s…" 5 weeks ago Exited (255) 4 weeks ago 0.0.0.0:3306->3306/tcp, 33060/tcp 6005_database_1 -5fecfd61782f 7024cem/webtrainer "docker-php-entrypoi…" 5 weeks ago Exited (255) 4 weeks ago 0.0.0.0:80->80/tcp 6005_web_1 -``` - -To remove a stopped containers use ```docker rm ``` - -``` -dang@DESKTOP-KJDVQ2J:~$ docker rm 6005-cw-koala_pyramid_1 -6005-cw-koala_pyramid_1 -``` - -### Image Management - -You can also manage the images currently installed on your system - -To list the current set of images use ```docker image list``` - -``` -dang@DESKTOP-KJDVQ2J:~$ docker image list -REPOSITORY TAG IMAGE ID CREATED SIZE -6005-cw-koala_pyramid latest afc71342b28f 4 weeks ago 946MB -python 3 5336a27a9b1f 5 weeks ago 886MB -cueh/ftpanon latest e68af1bf98d7 2 months ago 148MB -cueh/scanningweb latest 4d4adf600a0d 2 months ago 413MB -cueh/typewriter_postfix latest 7c2fe5b9677a 3 months ago 161MB -7024cem/webtrainer latest ee9ee758bfbe 18 months ago 382MB -7024cem/webdb latest 9b235fdedb19 18 months ago 376MB -cueh/debian_ssh latest 80f6116013fe 19 months ago 131MB -``` - -To remove an image: ```docker rmi ``` - -``` -dang@DESKTOP-KJDVQ2J:~$ docker rmi 6005-cw-koala_pyramid:latest -Untagged: 6005-cw-koala_pyramid:latest -Deleted: sha256:afc71342b28feb67e1e7a41a07a5450b432926f46daa6147b8eae98cb5771876 -Deleted: sha256:0311c5037503db900b04073069146141c186166a24b4861a26ec88bc750750e3 -Deleted: sha256:d538d349d16647f86d475cb1f52cf930d804f87e642c49a1bb846335af73ca84 -``` - - -There is also a command that will prune image layers that are not used by -anything else - -```docker image prune``` - - -## FAQ - -### You are asking me to install a lot of images, what about my HDD space. - -One of the really cool things about docker is the "layering" system. -This means that images can reuse elements of other images to reduce the -overall size. Unfortunately, the ```docker image list``` command reports the total size of -the image, rather than taking account of any layers its reusing[^image-size] - -I have tried to design the images we use to make best use of this layering -approach. For example, most of the web-based challenges use the same base -image, and the only thing unique to each one is the vulnerable website -itself. - -This means that you may have 10 web challenges each reporting as being -~200MB each, when in reality it' one "base" image of ~190MB, with a -separate 10MB layer for each challenge. So instead of 2GB it's only ~300 MB -of space that is actually used. - - -### I keep getting Permission Denied Errors - -Docker needs to run as the root user. Try repeating the command with sudo. -``` -$sudo docker-compose up -``` - -### I get asked if the Daemon is running - -If you get a message like - -``` -Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running? -``` - -In this case it's likely that docker is not started. You can confirm this -using whatever init tools you have (for example systemctl / init.d) - -``` -#Get Status of docker -$systemctl status docker - -#Start Docker -$systemctl start docker -``` - -### I get a message about network in use - -This can sometimes happen if we don't close docker-compose down correctly. -If we just stop the containers they are kept as *inactive* along with any -configuration that was in place. You can avoid this by using -```docker-compose down``` when you have finished a task - -Another method is to use the ```docker-network prune``` command. -As this will remove old network configurations from the list. - -### I cant access the system on WSL - -Usually, the docker container is running 'on top' of the host system. This -means that any services are exposed as they would be on localhost. - -However, with WSL, we are running our Linux base inside a virtualised -environment, so can't access at localhost. - -Instead, you will need to use the address of the WSL machine that is running docker. - - -[^image-size]: My laptop reports that the docker images take up more than -twice the space that I actually have available. \ No newline at end of file diff --git a/docs/guides/JoinTeams.png b/docs/guides/JoinTeams.png deleted file mode 100644 index d64fa32..0000000 Binary files a/docs/guides/JoinTeams.png and /dev/null differ diff --git a/docs/guides/LabGithub.md b/docs/guides/LabGithub.md deleted file mode 100644 index df0702d..0000000 --- a/docs/guides/LabGithub.md +++ /dev/null @@ -1,15 +0,0 @@ -# Lab Tasks GitHub - -To avoid having lab tasks scattered around my OneDrive, we will be using GitHub -to host any code for the task you are doing. - -You can find the repo at [TODO] - - -## Other Lab Materials - -If there are any other lab based materials you need to get hold of I will update -here. - - - diff --git a/docs/guides/LabSetup.md b/docs/guides/LabSetup.md deleted file mode 100644 index 9592725..0000000 --- a/docs/guides/LabSetup.md +++ /dev/null @@ -1,190 +0,0 @@ -# Setting up a Home Lab - -Sadly, it doesn't look like we are going to get access to the hacking lab. -This means that you are going to have to run the lab tasks on your own machines. - -In this article I will run through the process of setting up a home lab - -!!! important - - We will be going through this in week 1, to make sure everyone has access to the systems they will need for the module. - If you have things set up before then, excellent, but if not there will be a support session around getting your system set up for the module. - -## Linux - -We will be using Linux for the majority of the tasks. While this may not be -your preferred desktop environment, it does give us a lot of benefits over Windows. - - 1. We get a much more transparent system. While we can do almost all of the - labs in windows, its much more of a PITA. Usually with Linux things like - installing software, configuring permissions, or running more - "interesting" tools are much easier. - 2. While windows is still the most common desktop OS, Linux tends to rule the - server world, meaning it's arguably better to look at pen-testing that. - 3. It's where all the good pen-testing tools live - -When it comes to which version of Linux to use, its up to you[^arch]. However, there -are two distros that have a focus on penetration testing: - - - [Kali](https://www.kali.org/) - - [Parrot](https://www.parrotsec.org/) - -While we probably wont be using too many specialist tools, either of these -systems will have a wide range of software available for your pen-testing needs. - -??? note - - To be honest, I am going off of Kali at the moment. While lots of good things, like non-root user, have happened. - I still come across stability issues. (Also Gnome Desktop) - - However, it's likely I will use it for the lab sessions, so we are all on the same page. - -## Virtual Machines - -We will also want a VM platform to run the various Virtual Machines on, again -you have a couple of options here. - -!!! important - - If this is a problem for you, let me know ASAP, so I can try to sort something out. - - -### VMWare - -Is my personal preference. - -You can get a free copy of VMWare Pro / Fusion etc from the university at -[On the Hub](https://e5.onthehub.com/WebStore/Welcome.aspx?ws=d4489168-77fe-e111-bd05-f04da23e67f6&&utm_source=Coventry%20University) - -You can find it under "Productivity" - -### Virtual Box - -You can also use [Oracle VirtualBox](https://www.virtualbox.org/) - -Personally, I am less keen on this due to the networking (which I still haven't -quite got my head around) However, it is the virtualisation platform of choice -for the Uni image outside of the hacking lab. - -### WSL - -Windows subsystem for Linux is also becoming an option. It's pretty neat being -able to run Linux terminal applications natively in a Windows terminal. - -This should be OK for most of the lab tasks, but you may want a virtualisation -platform as a backup (and you will need one for Coursework 2). - -!!! important - - If I distrubute any VM's for the lab tasks, I will make sure they are in OVA format. - This means they *should* work on both systems - -## Docker - -The final piece of our lab setup. I like containerisation, it's a really neat -way of getting transferable setups between systems. - -Docker is a tool used to create "containers". These behave like lightweight -virtual machines, but, in fact, are cleverly constructed by creating filesystems -and network interfaces that exist on the host system and use the host's -resources. - -As there's a lot to cover, I have made a separate [guide to using docker](DockerGuide.md) - -### Installing Docker - -Depending on your OS you may need to go through different processes for -installing Docker. Links to the "official" docs are below for different OS. - - - [Debian like](https://docs.docker.com/engine/install/debian/) systems - - For Parrot follow the [Debian - like](https://docs.docker.com/engine/install/debian/) instructions - - [Kali](https://www.kali.org/docs/containers/installing-docker-on-kali/) - - -!!! important "Debian" - - Unfortunately it's not quite as easy as running ```apt install docker``` on debian. - - The *docker* name has been taken by an applet manager. Follow the instructions above to get it working. - -There are also some -[post installation](https://docs.docker.com/engine/install/linux-postinstall/) - tweaks you can use. - -Certainly I find that adding you user to the *docker* group (so you don't need to type -sudo each time) is a must[^docker-sudo] - - -!!! tip - - One thing you might want to do is add your user to the docker group. This - means you wont have to type sudo every time[^docker-sudo]. - - In a debian like system (kali / parrot / ubuntu) you can do this with - - ``` - $ sudo usermod -aG docker - ``` - - You will need to logout and login again for the permission to take effect. - - -### Docker-Compose - -We will also make a lot of use of docker-compose. This lets us setup "recipes" -for groups of docker containers. This means that rather than remembering -sometimes obscure docker syntax, we can just type ```docker-comopse up``` and -have all the containers start in the same way. - -The easiest way to install compose is via Python, although it is also -available through package managers. - -``` -sudo pip install docker-compose -``` - -## Other Useful Software - - - Git - - Use Verion Control, Enough Said. - - - A Decent Text editor - - You can't beat a decent text editor, you will want to be making lots of - notes, and something as heavy as word isn't really suitable for technical - notes. - - Grab one with Markdown Support: - - - Emacs - - VS Code / VS Codium - - Even VIM - - - Alternatives to using a text editor - - A few of you have suggested [Joplin](https://joplinapp.org/) for keeping - notes. I haven't used it that much in anger, but it seems like an - excellent tool. - - - - Pandoc - - [Pandoc](https://pandoc.org/) Is a tool that lets our convert between file - formats. Combined with a text editor it helps you make decent looking - reports / notes / writups with very little effort. - - - Asciinema - - [Asciinema](https://asciinema.org/) lets you record terminal sessions. - I hope to play around with this to record lab sessions, and make it easier - for you to replay what I do. - -[^arch]: Arch Obviously -[^docker-sudo]: Yes, we can argue about giving users what is effectively -password-less root. Convenience VS security is always a trade-off. - -*[PITA]: Pain In The Arris -*[VM]: Virtual Machines -*[WSL]: Windows Subsystem for Linux \ No newline at end of file diff --git a/docs/guides/Materials.md b/docs/guides/Materials.md deleted file mode 100644 index 5bf8076..0000000 --- a/docs/guides/Materials.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: "A guide to the module materials" ---- - -# A Guide to Module Materials - -While we will be using Aula to drive the module materials, all of the content -written is also available on GitHub Pages. - -Here is a quick overview of the conventions I will use here, where I get a few more formatting options. - -!!! important "Accessibility" - - One reason I have used the GitHub / Markdown approach in the past, is to help students with - accessibility issues. For example, I find it really hard to work outside of "Dark Mode". - - If you want to talk to me about this, please do, there is a heck of a lot we can do with - formatting that can help address any requirements you have. - -## Dark and Light Mode: - -Personally, I hate light mode, the contrast seems to make things much harder to -read, but I also appreciate it not for everyone. - -## Footnotes - -Will be used either to: - - - refer to other material (like a citation) - - As a note on something[^hidden-notes] - -## Breakout Boxes - -Throughout the text I will be using breakout boxes. -I will use this as a way to highlight important points or make tasks clear. - -I also use notes to replace the side-tracks that I tend to go down when -giving lectures... - -### Discussions - -Are intended to be talking points about the topics we learn. Use the aula to discuss these points with your class mates. -If you don't want to use the aula, its cool, expect to be asked your views in the lecture / lab sessions. - -!!! discuss - - A question to think about and discuss on the Aula - It will usually come with a ```#tag``` - -### Tasks - -I firmly believe that learning through doing is the best way of learning[^practical-subject]. -Throughout the module we will have lots of practical tasks for you to complete. - -There are also different levels of task. To get a decent grade in the module you should aim to complete all the easy, and standard tasks. -The hard tasks are there to give you the chance to explore the subject in more depth. - -!!! easytask "Easy Task" - - You **should** be able to do this to pass the module. - -!!! task "Task" - Being able to complete this should give you a decent grade. - -!!! hardtask "Hard Task" - **Optional** harder task for those who want to test their skills - - - -## Spotted a Bug or Typo - -Well done. Writing this module was hard because of how much content -went into it, and the nature of the topic. Just like writing code, -it's not possible to be 100% bug-free and although I try to catch any problems, -inevitably some will slip through the gaps[^custom-dict] - -The "minimising" step here is to try to get multiple people reading the -material in advance of the module start, using a spell-checker, and -developing in an environment that allows for version control, -separation of content and presentation, reducing duplication and the -chance for drift, etc. [^toolchain] - -As for catching bugs that make it through that process: you're the -beta tester. If you find a bug, typo, factual error or even just have -a good idea for improvement, let me know. Drop me a message at -([aa9863@coventry.ac.uk](mailto:aa9863@coventry.ac.uk)). Unless you -prefer to remain anonymous, you will be credited as a contributor to -the page. - -[^toolchain]: Markdown, MKDocs, Git -[^custom-dict]: You do not want to see the custom dictionary to get rid of the -"red squiggles", spell checkers do not like assembly code. -[^hidden-notes]: There may even be notes that are less visible. You are hackers, you know the drill. -[^practical-subject]: Its also a practical subject, you will need to do these tasks for the coursework. \ No newline at end of file diff --git a/docs/guides/MsTeams.md b/docs/guides/MsTeams.md deleted file mode 100644 index ddd13a4..0000000 --- a/docs/guides/MsTeams.md +++ /dev/null @@ -1,29 +0,0 @@ -# Online Lectures - -We will be using MS Teams for the Online Lectures. - -You will need to join the Teams Channel. (or ping me if you have access -problems) - -To do this. - - 1. Go to Microsoft Teams - 2. Click on **Create or Join Team** - 3. Use the Code **TODO** - -![Joining Teams](JoinTeams.png) - - -!!! discuss "Why Teams?" - - There are a few platforms we could use for the live lectures but why teams? - - - I have found it easy to use, and it integrates nicely with the streams - platform for sharing recordings as everything works with the university - systems - - You don't need to create a new account for anything (unlike zoom) to join the lectures. - While we could argue about the Uni's use of MS for everything (and the - creepy, unasked for, integrations with Edge) its an account that you - **have no choice** over having. - - If enough people want to move to a different platform, I am happy to discuss it. diff --git a/docs/guides/TeachingAndLearning.md b/docs/guides/TeachingAndLearning.md deleted file mode 100644 index e7fc39d..0000000 --- a/docs/guides/TeachingAndLearning.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: "Teaching and Learning" ---- - - -# How You will get Taught - -Due to the "Lessons Learnt" from the Plague[^not-that-plague] the module will be "Blended Delivery". -This means you have a combination of Offline (or Asynchronous) pre-reading, and Face-To-Face (Synchronous), -lab sessions. There will also be a purely online option, where you join us in the lab session remotely. - -!!! important "No Lectures" - - - - The Blended learning style means that there wont be any "Traditional" lectures. - Instead we have a combination of the Offline learning, and Practical activities. - - - - While this is good in a couple of ways: You get to study when you want, no - trekking into the Uni at 9AM just to be talked at, or having to buy extortionate Starbucks coffee. - It does mean that you are more responsible for your own learning. - - -## GitHub pages and the aula. - -The aula is the main reference point for the module. -We will have a summary for the topics each week, along with any discussion / questions on the topics and tasks. - -The feed is a good idea[^seriously], I find that discussing concepts with my peers helps me get the topic straight in my head[^learning-style]. -Make use of the feed to ask questions other than "When will the coursework be marked", and discuss the concepts we talk about. - -The bulk of the materials will be on GitHub pages. -I find it a much nicer experience to write for, and feedback from the students last year, was positive overall. - - - - -## Module Materials - -### Offline Pre-Reading - -Each week you will have some offline pre-reading work. -This will usually consist of some reading materials (hosted here), -videos. and depending on the topic, a demo task to help you work through the -concepts. - -!!! tip "Reading the Pre-Reading" - - It's going to make your life so much easier if you read the materials before the Lab takes place (or at least in the same week as the materials). - It means, at the least, you can ask questions relevant to bits you dont understand. - - Also, there's a lot to cover, stuff builds on other topics, and trying to cram in the last few weeks probably isn't going to work[^hate-failing] - -### Lab Sessions - -We will also have face to face lab sessions[^timetable]. -As a practical subject, this will give you the change to practice the topics we from the Offline parts of the course. - -The Lab Sessions will include: - - - Brief Q&A on the topics for that week - - Practical activity exploring the topics for that week. - - -!!! note "Mini Lectures" - - The rules give us scope for a "Mini Lecture" where we can cover any questions you have. - If we do anything like this I will be sure to record it and make it available. - - -[^not-that-plague]: [Sadly not this Plague](https://youtu.be/LkqKFamTkME) -[^seriously]: I mean that. The aula has some good ideas around communications. Its easy to bash the aula for being poorly implemented, but the ideas around having conversations about the topics is a good one. But, the pain of using the editor to get content onto the damn thing, lack of dark mode, and dire formatting options mean I will be using GH pages for the content. -[^hate-failing]: I hate failing people, it always makes me feel guilty.[^fail-note] -[^fail-note]: However, that doesn't mean you can expect to pass without doing -some work. While I am happy to help explain things, being asked to pull your arris -out of the fire by covering the whole module in the last two weeks tends to put me -in a bad mood. - -[^timetable]: Although at the time of writing, I have no idea what the timetable looks like. -[^learning-style]: Other learning Styles are available diff --git a/docs/guides/index.md b/docs/guides/index.md deleted file mode 100644 index f3cba30..0000000 --- a/docs/guides/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "Tools and Materials" -description: "A set of notes on tools and materials you may find useful for the module, and for the course in general" ---- - - -# Tools and Materials - -For the security modules we tend to make use of virtualisation technologies to help us play with concepts -without endangering your primary OS. - -This section has a set of general guides to installing and using the tech. - - - [GitHub Pages Materials Guide](Materials.md) - - [Home Lab Setup](LabSetup.md) - - [A Guide to Docker](DockerGuide.md) diff --git a/mkdocs.yml b/mkdocs.yml index 7b36114..08b4c53 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,8 @@ site_name: "Template MKDocs" #site_dir: "pages/aa9863/6005-CEM" -site_url: https://github.coventry.ac.uk/pages/aa9863/6005-CEM #Update this to - +site_url: https://github.coventry.ac.uk/pages/CUEH/6005CEM/ #Update this to +repo_name: cueh/6005CEM +repo_url: https://github.coventry.ac.uk/CUEH/6005CEM theme: name: material @@ -41,6 +42,7 @@ markdown_extensions: - pymdownx.keys - pymdownx.tasklist - pymdownx.smartsymbols + - pymdownx.tilde - pymdownx.arithmatex: generic: true - pymdownx.emoji: #Custom Icons (Looks like we need the Emojii) @@ -57,24 +59,14 @@ extra_javascript: - https://polyfill.io/v3/polyfill.min.js?features=es6 - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js - #repo_name: aa9863/6005-CEM -#repo_url: https://github.coventry.ac.uk/aa9863/6005-CEM nav: - Home: index.md - Essentials: - Module Guide: essentials/moduleguide.md - - Assessment: assessment/assessment.md - - Teaching and Learning: guides/TeachingAndLearning.md - - MS Teams: guides/MsTeams.md - - Guides: - - Overview: guides/index.md - - Using These Materials: guides/Materials.md - - Home Lab Setup: guides/LabSetup.md - - Docker Guide: guides/DockerGuide.md - - Github Labs: guides/LabGithub.md - Assesment: + - Assessment Overview: assessment/assessment.md - Assessment Example: assessment/ExampleCW.md