Permalink
Browse files

Remove the GitHub repo link in the header

Setting the repo_url in mkdocs.yml gives me the "Edit this file" button,
which I want. It also gives me a little GitHub badge in the upper right,
which I do NOT want. It's not useful here and it's very distracting
because it's animated.

There is a concern with this commit: to implement this change to
mkdocs-material template, I had to override the partials/header.html file
and remove the part I don't want.
This could be bad when we upgrade the template. We won't see improvements
to the header.
When we upgrade the template, we should check for changes in that file
and, if there are any, re-apply this change to the latest header.html
  • Loading branch information...
jessitron committed Oct 12, 2018
1 parent c2152b1 commit f71d779e8e198b5d3e57a54297bcfa850f5eca61
Showing with 1 addition and 7 deletions.
  1. +1 −7 theme/partials/header.html
@@ -37,13 +37,7 @@
{% endif %}
{% endblock %}
</div>
{% if config.repo_url %}
<div class="md-flex__cell md-flex__cell--shrink">
<div class="md-header-nav__source">
{% include "partials/source.html" %}
</div>
</div>
{% endif %}
<!-- Jess: I don't want to display the GitHub repo link. Only the edit link. -->>
</div>
</nav>
</header>

0 comments on commit f71d779

Please sign in to comment.