Initial commit

aa1910 · Jan 9, 2023 · c67356b19bc40172102ac22095b18bddb4953aef · c67356b
commit c67356b19bc40172102ac22095b18bddb4953aef
Show file tree

Hide file tree

Showing 11 changed files with 280 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+*~
+/venv/
diff --git a/Makefile b/Makefile
@@ -0,0 +1,37 @@
+INVENV = $(shell pip3 -V | grep 'venv')
+current_dir = $(shell pwd)
+MKDOCS_PORT=8004
+
+
+build:
+	# cd docs/assessment/cw1 && remarkable -d ../ -t cwTemplate.jinja2 cw1_brief.md
+	# cd docs/assessment/cw2 && remarkable -d ../ -t cwTemplate.jinja2 cw2_brief.md
+	# cd docs/assessment/resit && remarkable -d ../ -t cwTemplate.jinja2 cw1_resit_brief.md && remarkable -d ../ -t cwTemplate.jinja2 cw2_resit_brief.md
+
+	mkdocs build --clean
+
+serve:
+	mkdocs serve --dev-addr localhost:$(MKDOCS_PORT)
+
+publish:
+	mkdocs gh-deploy --config-file ./mkdocs.yml --remote-branch gh-pages
+
+clean:
+	rm -rf ./site
+
+
+prereqs: venvcheck FORCE
+	pip install -r requirements.txt
+	#cd reMarkAble && python setup.py install
+venv: FORCE
+	python3 -m venv venv
+
+venvcheck:
+ifeq ($(INVENV),)
+	$(error You should only run this from within the venv. Use '. ./venv/bin/activate')
+else
+	@echo "venv check passed\n"
+endif
+
+
+FORCE:
diff --git a/README.md b/README.md
@@ -0,0 +1,9 @@
+# Bootcamp template
+
+This file isn't readable when published, but is useful for staff with
+github access to store information. It uses the same basic markdown as
+everything else.
+
+## Todo
+
+1. Add info on rendering and publishing the repo
diff --git a/docs/css/extra.css b/docs/css/extra.css
@@ -0,0 +1,52 @@
+@import url("https://fonts.googleapis.com/css2?family=Share+Tech+Mono&display=swap");
+.md-header, .md-footer{
+
+ background: rgb(234,243,246);
+ background: linear-gradient(0deg, rgba(234,243,246) 0%, rgba(251,233,135) 100%);
+ color: #000;
+
+}
+
+.md-header img{
+
+     box-shadow: 0 0 5px #555;
+}
+
+.codetitle, .codetitle code{
+    background: #ccc;
+    color: #333;
+}
+
+.codetitle a{
+    color: #00f;
+    margin: 0px 1em;
+}
+
+.codeblock{
+    padding:1em;
+    border: 1px solid #333;
+}
+
+.dlbtn{
+    float:right;
+}
+
+
+img[src*="#screenshot"], pre.terminal{
+    -webkit-box-shadow: 10px 10px 23px 0px rgba(0,0,0,0.38);
+    -moz-box-shadow: 10px 10px 23px 0px rgba(0,0,0,0.38);
+    box-shadow: 10px 10px 23px 0px rgba(0,0,0,0.38);
+    border: #931 1px solid;
+
+}
+
+
+pre.terminal{
+    padding:1ex;
+    color: #EEEECC;
+    background: #110;
+    font-family: 'Share Tech Mono', monospace;
+    font-size: 12pt;
+}
+
+
diff --git a/docs/deer.jpg b/docs/deer.jpg
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,83 @@
+# Main Page (Title here)
+
+Introduction to the topic.
+
+A [link to the bootcamp course overview](overview.md), which will have
+the schedule and staffing for this run (keeping all other pages fairly
+reusable).
+
+## Basic markdown
+
+Everything is just plain text, with minimal markup to add formatting and structure.
+
+Reference for the basics: <https://commonmark.org/help/>
+
+*Italic*, **bold**, `preformatted`, etc are done like this:
+
+```
+*Italic*, **bold**, `preformatted`, etc are done like this:
+```
+
+## An image
+
+![deer](deer.jpg "Picture of a baby deer. A calf? Foal?")
+
+The image has alt text and a hover tooltop.
+
+## Some code
+
+```python
+print("This is Python")
+os.system("ls")
+```
+
+## Useful boxes
+
+!!! note "Make a note!"
+    This is something of note.  You can put stuff here to highlight it.
+
+!!! question "Or ask a question?"
+    This one is open
+
+??? question "But you can hide the text until clicked"
+    Maybe a self-test question with hidden answer for checking.
+
+!!! warning "This one is very important"
+    Not sure what it would be
+
+
+
+!!! info inline end
+    You can also put the box to the right of something. 
+
+Pellentesque dapibus suscipit ligula.  Donec posuere augue in quam.  Etiam vel tortor sodales tellus ultricies commodo.  Suspendisse potenti.  Aenean in sem ac leo mollis blandit.  Donec neque quam, dignissim in, mollis nec, sagittis eu, wisi.  Phasellus lacus.  Etiam laoreet quam sed arcu.  Phasellus at dui in ligula mollis ultricies.  Integer placerat tristique nisl.  Praesent augue.  Fusce commodo.  Vestibulum convallis, lorem a tempus semper, dui dui euismod elit, vitae placerat urna tortor vitae lacus.  Nullam libero mauris, consequat quis, varius et, dictum id, arcu.  Mauris mollis tincidunt felis.  Aliquam feugiat tellus ut neque.  Nulla facilisis, risus a rhoncus fermentum, tellus tellus lacinia purus, et dictum nunc justo sit amet elit.
+
+
+You can see a list of these here: <https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types>
+
+
+## Lists
+
+ - really simple
+ - Just a dash or star at the start of the line
+
+Or for numbers:
+
+1. Thing 1
+2. Another thing
+3. Third thing
+
+
+## Grouping
+
+Handy sometimes
+
+=== "Pros"
+
+    * Sed sagittis eleifend rutrum
+    * Donec vitae suscipit est
+    * Nulla tempor lobortis orci
+
+=== "Cons"
+
+    Doesn't have to be a list. Sed id ligula quis est convallis tempor.  
diff --git a/docs/overview.md b/docs/overview.md
@@ -0,0 +1,19 @@
+# Bootcamp Overview
+
+## Learning Outcomes 
+
+## Delivery
+
+### Weekly Schedule
+
+| Week        | Beginning     | Topic                                |
+| ----------- | ------------- | ------------------------------------ |
+| 1           | 2022-01-31    |                                      |
+| 2           | 2022-02-07    |                                      |
+| 3           | 2022-02-14    |                                      |
+| 4           | 2022-02-21    |                                      |
+| 5           | 2022-02-28    |                                      |
+| 6           | 2022-03-07    |                                      |
+| 7           | 2022-03-14    |                                      |
+| 8           | 2022-03-21    |                                      |
+
diff --git a/docs/week1/activity.md b/docs/week1/activity.md
@@ -0,0 +1,6 @@
+# Some activity
+
+Pellentesque dapibus suscipit ligula.  Donec posuere augue in quam.  Etiam vel tortor sodales tellus ultricies commodo.  Suspendisse potenti.  Aenean in sem ac leo mollis blandit.  Donec neque quam, dignissim in, mollis nec, sagittis eu, wisi.  Phasellus lacus.  Etiam laoreet quam sed arcu.  Phasellus at dui in ligula mollis ultricies.  Integer placerat tristique nisl.  Praesent augue.  Fusce commodo.  Vestibulum convallis, lorem a tempus semper, dui dui euismod elit, vitae placerat urna tortor vitae lacus.  Nullam libero mauris, consequat quis, varius et, dictum id, arcu.  Mauris mollis tincidunt felis.  Aliquam feugiat tellus ut neque.  Nulla facilisis, risus a rhoncus fermentum, tellus tellus lacinia purus, et dictum nunc justo sit amet elit.
+
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit.  Donec hendrerit tempor tellus.  Donec pretium posuere tellus.  Proin quam nisl, tincidunt et, mattis eget, convallis nec, purus.  Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.  Nulla posuere.  Donec vitae dolor.  Nullam tristique diam non turpis.  Cras placerat accumsan nulla.  Nullam rutrum.  Nam vestibulum accumsan nisl.
+
diff --git a/docs/week1/index.md b/docs/week1/index.md
@@ -0,0 +1,16 @@
+# Week X Title
+
+Pellentesque dapibus suscipit ligula.  Donec posuere augue in quam.  Etiam vel tortor sodales tellus ultricies commodo.  Suspendisse potenti.  Aenean in sem ac leo mollis blandit.  Donec neque quam, dignissim in, mollis nec, sagittis eu, wisi.  Phasellus lacus.  Etiam laoreet quam sed arcu.  Phasellus at dui in ligula mollis ultricies.  Integer placerat tristique nisl.  Praesent augue.  Fusce commodo.  Vestibulum convallis, lorem a tempus semper, dui dui euismod elit, vitae placerat urna tortor vitae lacus.  Nullam libero mauris, consequat quis, varius et, dictum id, arcu.  Mauris mollis tincidunt felis.  Aliquam feugiat tellus ut neque.  Nulla facilisis, risus a rhoncus fermentum, tellus tellus lacinia purus, et dictum nunc justo sit amet elit.
+
+## Subheading
+
+Nullam eu ante vel est convallis dignissim.  Fusce suscipit, wisi nec facilisis facilisis, est dui fermentum leo, quis tempor ligula erat quis odio.  Nunc porta vulputate tellus.  Nunc rutrum turpis sed pede.  Sed bibendum.  Aliquam posuere.  Nunc aliquet, augue nec adipiscing interdum, lacus tellus malesuada massa, quis varius mi purus non odio.  Pellentesque condimentum, magna ut suscipit hendrerit, ipsum augue ornare nulla, non luctus diam neque sit amet urna.  Curabitur vulputate vestibulum lorem.  Fusce sagittis, libero non molestie mollis, magna orci ultrices dolor, at vulputate neque nulla lacinia eros.  Sed id ligula quis est convallis tempor.  Curabitur lacinia pulvinar nibh.  Nam a sapien.
+
+## Subheading also
+
+Nullam eu ante vel est convallis dignissim.  Fusce suscipit, wisi nec facilisis facilisis, est dui fermentum leo, quis tempor ligula erat quis odio.  Nunc porta vulputate tellus.  Nunc rutrum turpis sed pede.  Sed bibendum.  Aliquam posuere.  Nunc aliquet, augue nec adipiscing interdum, lacus tellus malesuada massa, quis varius mi purus non odio.  Pellentesque condimentum, magna ut suscipit hendrerit, ipsum augue ornare nulla, non luctus diam neque sit amet urna.  Curabitur vulputate vestibulum lorem.  Fusce sagittis, libero non molestie mollis, magna orci ultrices dolor, at vulputate neque nulla lacinia eros.  Sed id ligula quis est convallis tempor.  Curabitur lacinia pulvinar nibh.  Nam a sapien.
+
+### And another level down
+
+And you can [link to local files](activity.md)
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,45 @@
+site_name: 'Bootcamp Title'
+
+nav:
+  - Home: index.md
+  - 'Overview': 'overview.md'
+  - 'Week 1: Topic':
+    - 'Introduction': 'week1/'
+    - 'Activity': 'week1/activity.md'
+
+markdown_extensions:
+  - codehilite
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.keys
+  - footnotes
+  - mdx_math
+  - pymdownx.tabbed:
+      alternate_style: true 
+plugins:
+  - search
+  - macros
+
+
+#extra:
+#  codelink: 'https://github.coventry.ac.uk/pages/CUEH/py-quickstart'
+#  codelink: 'http://localhost:8000'
+
+
+theme:
+  name: material
+  palette:
+    scheme: preference
+
+extra_css:
+  - css/extra.css
+
+
+extra_javascript: 
+  - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML
+  - https://polyfill.io/v3/polyfill.min.js?features=es6
+  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,11 @@
+mkdocs>=0.17.1
+mkdocs-markdownextradata-plugin
+mkdocs-material
+markdown-blockdiag
+WeasyPrint
+mkdocs-pdf-export-plugin 
+mkdocs-macros-plugin
+mkdocs-windmill
+pdoc3
+markdown
+python-markdown-math