reanahub / docs.reana.io

REANA documentation web site
http://docs.reana.io
MIT License
3 stars 31 forks source link

setup: migrate to mkdocs-material version 5 #41

Open mvidalgarcia opened 4 years ago

mvidalgarcia commented 4 years ago

mkdocs-material version 5 has brought many changes but unfortunately is incompatible with our current state of repo.

They have written a nice guide on how to update to version 5.x: https://squidfunk.github.io/mkdocs-material/releases/5/

I followed this step.

diff --git a/mkdocs.yml b/mkdocs.yml
index bf0da72..3835793 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -27,13 +27,13 @@ theme:
 # Customization
 extra:
   social:
-  - type: 'github'
+  - icon: 'fontawesome/brands/github-alt'
     link: 'https://github.com/reanahub'
-  - type: 'twitter'
+  - icon: 'fontawesome/brands/twitter'
     link: 'https://twitter.com/reanahub'
-  - type: 'comments'
+  - icon: 'fontawesome/brands/discourse'
     link: 'https://forum.reana.io'
-  - type: 'globe'
+  - icon: 'fontawesome/solid/globe'
     link: 'http://www.reana.io'
 extra_css:
   - stylesheets/extra.css

That was the only one breaking our build, but still, the appearance doesn't look as what we currently have:

image

Stuff to adapt/fix:

mvidalgarcia commented 3 years ago

Here the diff of ILS documentation upgrade, that might be useful as reference.