Skip to content

Commit

Permalink
Changed theme to Material
Browse files Browse the repository at this point in the history
  • Loading branch information
MartenBE committed Mar 12, 2024
1 parent 107cb94 commit dd3a7ae
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 128 deletions.
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,7 @@ mkdocs serve

### Theme

If you want another theme, you can change edit the `extra_css` entry in [mkdocs.yml](./mkdocs.yml) to point to another CSS file. You can also use an existing link like https://hogenttin.github.io/hogent-mkdocs/docs/theme.css .

If you copy or fork this repo, but always want to keep the theme of your documentation website at any time automatically in sync with this repo, you can ... .

1. Set the `extra_css` entry in [mkdocs.yml](./mkdocs.yml) to the URL https://hogenttin.github.io/hogent-mkdocs/docs/theme.css .
2. Delete the [local CSS file](./docs/theme.css).
If you want another theme, you can change edit the `theme` entry in [mkdocs.yml](./mkdocs.yml). You can find a lot of themes at https://github.com/mkdocs/catalog#-theming .

### [MkDocs](https://www.mkdocs.org/) options

Expand Down
117 changes: 0 additions & 117 deletions docs/theme.css

This file was deleted.

31 changes: 27 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,29 +1,52 @@
site_name: hogent-mkdocs
site_url: https://hogent.be
copyright: Copyright &copy; HOGENT (<a href="https://hogent.be">https://hogent.be</a>)
nav:
- Home: ./index.md
- Basic examples: ./examples/h1.md
- Advanced examples: ./examples/h2.md
- Links: ./links.md
theme:
name: readthedocs
name: material # https://squidfunk.github.io/mkdocs-material/setup/
favicon: https://hogent.be/themes/hogent/images/ico/favicon.ico
features:
- content.code.copy
- navigation.path
- navigation.top
- navigation.tracking
- toc.integrate
- toc.follow
font:
text: Montserrat
code: Inconsolata
logo: https://www.hogent.be/sites/hogent/assets/Image/logo-1.jpg
markdown_extensions:
- footnotes
- pymdownx.arithmatex:
generic: true
- pymdownx.highlight:
anchor_linenums: true
auto_title: true
linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.magiclink
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tasklist
- pymdownx.tilde
- toc:
permalink: true
plugins:
- mermaid2
- git-revision-date-localized:
fallback_to_build_date: true
type: datetime
- plantuml:
puml_url: https://www.plantuml.com/plantuml/
num_workers: 8
- search
extra_javascript:
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js
extra_css:
- ./theme.css
3 changes: 2 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
mkdocs
mkdocs-material
pymdown-extensions
mkdocs-mermaid2-plugin
mkdocs_puml
mkdocs-git-revision-date-localized-plugin

0 comments on commit dd3a7ae

Please sign in to comment.