Skip to content

Commit

Permalink
re-order footer entry
Browse files Browse the repository at this point in the history
  • Loading branch information
julia-pfarr committed Oct 13, 2023
1 parent 428128a commit 543f6c8
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 5 deletions.
1 change: 0 additions & 1 deletion docs/custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,6 @@ theme:
```



[Google Slides]: https://docs.google.com/presentation/d/16Rgdn_-uqjZVwmeyDhGL41vKMRCFA0dSom2IpreZ59I/edit?usp=sharing
[setup page]: https://squidfunk.github.io/mkdocs-material/setup/
[localhost:8000]:http://localhost:8000
Expand Down
15 changes: 13 additions & 2 deletions docs/extras.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,12 +103,23 @@ Highlighting:
##### Task 4
Go to the [setup page] by Material for Mkdocs and find out about more customizations (e.g., page headers and the footer).
Go to the [setup page] by Material for Mkdocs and find out about more customizations. E.g., for the footer Icons for social media can be included by defining them in the `mkdocs.yml` file like this:
```yaml
extra:
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/your-account
- icon: material/email
link: mailto:email-address
```
The icon will then appear in the footer of your website. You can search for the icons [here], replacing the `-` with `/` when you enter it in your yaml-file.


## Blog

If you want to set up a blog on your website you might want to think about using the [Blog-Plugin] by Mkdocs. This plugin enables features such as adding a date, reading time, tags, and topics for your blog entries ([example Blog] from their website). If you don't use the Blog-Plugin you can just as well create usual Markdown-files and order them in your .yaml file accordingly, like so:
If you want to set up a blog on your website you might want to think about using the [Blog-Plugin] by Mkdocs. This plugin enables features such as adding a date, reading time, tags, and topics for your blog entries ([example Blog] from their website).

If you don't use the Blog-Plugin you can just as well create usual Markdown-files and order them in your .yaml file accordingly, like so:
```yaml
nav:
- Home: index.md
Expand Down
4 changes: 2 additions & 2 deletions docs/installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ hide:
- navigation
---

To actively participate in the workshop you should have...
To actively participate in the workshop you need to have...

1. ... [python] installed in order to use pip for installing the python packages we need for setting up the website.<br><br>
When you have python installed, run the following command in your terminal in order to install "Material for mkdocs", which we will use to create our website:
Expand All @@ -19,7 +19,7 @@ pip install \
- syntax highlighting for multiple languages (which we will need)
- displaying multiple files next to each other (we will need to modify content in multiple files simultaneously)
- preview for rendered markdown-files (which we will work with to design the content)
4. [Git] installed and configured on your local computer.
4. ... [Git] installed and configured on your local computer.



Expand Down

0 comments on commit 543f6c8

Please sign in to comment.