Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

setup: migrate to mkdocs-material version 5 #41

Open
7 tasks
mvidalgarcia opened this issue Apr 16, 2020 · 1 comment
Open
7 tasks

setup: migrate to mkdocs-material version 5 #41

mvidalgarcia opened this issue Apr 16, 2020 · 1 comment

Comments

@mvidalgarcia
Copy link
Member

mvidalgarcia commented Apr 16, 2020

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:

  • Logo dimensions
  • Horizontal tab menu missing
  • Some blue colored links (see "Welcome" in screenshot)
  • Black borders (footer)
  • Adapt social icons
  • Some of our css customizations are gone (check and cleanup). Take advantage of this to use the brand new css variables For instance, something like the following will convert all the active links into green.
    :root [data-md-color-primary="white"] {
        --md-primary-fg-color: green;
    }
  • Etc.
mvidalgarcia added a commit to mvidalgarcia/docs.reana.io that referenced this issue Apr 16, 2020
Version >=5 breaks our customizations
reanahub#41
@mvidalgarcia mvidalgarcia changed the title mkdocs-material: migrate to version 5 setup: migrate to mkdocs-material version 5 Apr 16, 2020
mvidalgarcia added a commit to mvidalgarcia/docs.reana.io that referenced this issue Apr 16, 2020
Version >=5 breaks our customizations (reanahub#41)
@mvidalgarcia
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant