TEMPLATE_README.md

# 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.