generated from aa9863/mkdocs-template
Permalink
Show file tree
Hide file tree
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
37 changed files
with
2,326 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
env | ||
site |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"python.pythonPath": "c:\\Users\\dang\\Documents\\GitHub\\mkdocs-template\\env\\Scripts\\python.exe" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
mk-docs | ||
arris |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
mkdocs-material |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Custom Modifications for Mk-Docs | ||
|
||
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 | ||
|
||
https://squidfunk.github.io/mkdocs-material/ | ||
|
||
## Usage Notes | ||
|
||
### Install | ||
|
||
With python. (I would also use a virtualenv) | ||
|
||
``` | ||
pip install -r REQUIREMENTS.txt | ||
``` | ||
|
||
### Uploading the docs | ||
|
||
``` | ||
mkdocs gh-deploy | ||
``` | ||
|
||
|
||
|
||
## Notes for Updating | ||
|
||
If I make changes it may be useful to update any other repos | ||
We can do this with | ||
|
||
|
||
``` | ||
PS C:\Users\dang\Documents\GitHub\245CT> git remote add template https://github.coventry.ac.uk/aa9863/mkdocs-template.git | ||
PS C:\Users\dang\Documents\GitHub\245CT> git fetch --all | ||
PS C:\Users\dang\Documents\GitHub\245CT> git merge template/main --allow-unrelated-histories | ||
Merge made by the 'recursive' strategy. | ||
``` | ||
|
||
## CHANGES | ||
|
||
- Material 7.2.1 | ||
- 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. | ||
|
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
{% extends "base.html" %} | ||
|
||
{% block content %} | ||
|
||
<h1>{{ page.meta.title }}</h1> | ||
|
||
|
||
{% if page.meta.rendername %} | ||
<div class="admonition important"> | ||
<p class="admonition-title">Assessment brief</p> | ||
<a href="{{ page.meta.rendername | url }}" target="_blank" rel="noopener noreferrer"> View as Coursework Brief</a> | ||
</div> | ||
{% endif %} | ||
|
||
<h3>Submission Informtion</h3> | ||
<table> | ||
<tbody> | ||
<tr> | ||
<td>Handout Date</td> | ||
<td>{{ page.meta.handout }}</td> | ||
</tr> | ||
<tr> | ||
<td>Due Date</td> | ||
<td>{{ page.meta.due }}</td> | ||
</tr> | ||
<tr> | ||
<td>Estimated Effort</td> | ||
<td>{{ page.meta.effort }}</td> | ||
</tr> | ||
<tr> | ||
<td>Percentage of Module Mark</td> | ||
<td>{{ page.meta.percentage }}</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
<h3>ILO's Assessed</h3> | ||
|
||
<ul> | ||
{% for item in page.meta.ilos %} | ||
<li>{{ item }}</li> | ||
{% endfor %} | ||
</ul> | ||
|
||
{{ super() }} {# Call super to load the parent version of this #} | ||
|
||
{% endblock %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
{% extends "base.html" %} | ||
|
||
|
||
|
||
{% block extrahead %} | ||
<!--- EXTRA HEAD INFORMATIUON CUSTOM TEMPLATE --> | ||
{% set title = config.site_name %} | ||
{% if page and page.meta and page.meta.title %} | ||
{% set title = title ~ " - " ~ page.meta.title %} | ||
{% elif page and page.title and not page.is_homepage %} | ||
{% set title = title ~ " - " ~ page.title | striptags %} | ||
{% endif %} | ||
|
||
{% if page and page.meta and page.meta.description %} | ||
{% set description = page.meta.description %} | ||
{% endif %} | ||
|
||
<meta name="robots" content="noindex, nofollow, none" /> | ||
|
||
<meta property="og:type" content="website" /> | ||
<meta property="og:title" content="{{ title }}" /> | ||
{#<meta property="og:description" content="{{ config.site_description }} /> #} | ||
{% if description %} | ||
<meta property="og:description" content="{{ description }}" /> | ||
|
||
{% endif %} | ||
|
||
<meta property="og:url" content="{{ page.canonical_url }}" /> | ||
{# | ||
<meta property="og:image" content="https://github.coventry.ac.uk/pages/aa9863/5067CEM/1_HTTP/images/HTTP_Request.png" /> | ||
<meta property="og:image:type" content="image/png" /> | ||
<meta property="og:image:width" content="1200" /> | ||
<meta property="og:image:height" content="630" /> | ||
#} | ||
|
||
{% endblock %} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
{#- | ||
This file was automatically generated - do not edit | ||
-#} | ||
<div class="md-copyright"> | ||
{% if config.copyright %} | ||
<div class="md-copyright__highlight"> | ||
{{ config.copyright }} | ||
</div> | ||
{% endif %} | ||
|
||
<div> | ||
<a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc/4.0/80x15.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/">Creative Commons Attribution-NonCommercial 4.0 International License</a>. | ||
</div> | ||
|
||
{% if not config.extra.generator == false %} | ||
Made with | ||
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> | ||
Material for MkDocs | ||
</a> | ||
{% endif %} | ||
|
||
|
||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
<!-- ANALYTICS SCRIPT --> | ||
{{ config.extra.analytics.script }} |
Oops, something went wrong.