diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4f6e7fe --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +*~ +/venv/ diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..e69adb5 --- /dev/null +++ b/Makefile @@ -0,0 +1,37 @@ +INVENV = $(shell pip3 -V | grep 'venv') +current_dir = $(shell pwd) +MKDOCS_PORT=8008 + + +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/docs/css/extra.css b/docs/css/extra.css new file mode 100644 index 0000000..98ef2ab --- /dev/null +++ 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(134,143,146) 0%, rgba(191,193,165) 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/images/logo_col.png b/docs/images/logo_col.png new file mode 100644 index 0000000..56aa226 Binary files /dev/null and b/docs/images/logo_col.png differ diff --git a/docs/images/logo_ico.jpg b/docs/images/logo_ico.jpg new file mode 100644 index 0000000..5a7a850 Binary files /dev/null and b/docs/images/logo_ico.jpg differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..67f753f --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +# Chromebook stuff diff --git a/docs/powerwash.md b/docs/powerwash.md new file mode 100644 index 0000000..c530dc6 --- /dev/null +++ b/docs/powerwash.md @@ -0,0 +1 @@ +# Powerwashing diff --git a/docs/setup.md b/docs/setup.md new file mode 100644 index 0000000..8847272 --- /dev/null +++ b/docs/setup.md @@ -0,0 +1 @@ +# First-time setup diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..501c81b --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,48 @@ +site_name: 'CUEH Chromebook Repo' + +nav: + - Home: index.md + - 'First-time setup': 'setup.md' + - 'Powerwashing': 'powerwash.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 +plugins: + - search + - macros + + +extra: +# codelink: 'https://github.coventry.ac.uk/pages/CUEH/py-quickstart' +# codelink: 'http://localhost:8000' + draft: 1 + year: '2021/22' + + + +theme: + name: material + palette: + scheme: preference + logo: 'images/logo_ico.jpg' + #custom_dir: custom_theme + favicon: images/logo_ico.jpg +extra_css: + #- css/mk_ultra.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 new file mode 100644 index 0000000..429c336 --- /dev/null +++ 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