Repository information facelift (Stars, Forks, Latest Release...)
See original GitHub issueDescription
Allow a user to configure mkdocs-material to display the latest github release version for a linked repo.
Use Cases
Github releases are used more and more to distribute source code or pre-built artifacts. Since mkdocs-material doc site is often a front of the underlying repo (effectively being a home page of a project in lots of cases) it seems very valuable to display the latest available release of the project.
Screenshots / Mockups
I leave it to the contributors/authots to decided what is the best way to display that information, a very simple mockup can look like that:
The assumption here is that clicking on the release <li>
element will forward a user to the gh releases page directly, instead of the repo main page
Issue Analytics
- State:
- Created 3 years ago
- Reactions:1
- Comments:5 (3 by maintainers)
Top Results From Across the Web
The repository fork button now displays existing forks
A dropdown has been added to the Fork button to help you quickly find your forks of a repository. This includes forks in...
Read more >Changelog - Material for MkDocs - GitHub Pages
Bumped MkDocs version to 1.3.0 to mitigate breaking changes in Jinja ... Added latest release to repository info (GitHub); Slight facelift of repository...
Read more >Project section facelift - Hrafn Thorvaldsson
The repository.json file is now available for use. Now all that was needed was to process the data, and for that Hugo already...
Read more >threads-foundation - npm Package Health Analysis - Snyk
Foundation for the threads design system For more information about how to use this package see ... Latest version published 6 years ago...
Read more >KieScanner - Drools Documentation - JBoss.org
The Metadata tab provided in previous versions was redesigned to provide a better asset versioning information browsing and recovery. Now every workbench editor ......
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
So I think I’m all for pulling off a slight facelift of the repository container, as it hasn’t received any love since version 1. We could replace the titles with GitHub’s own icons (it’s more international anyway), and maybe allow for some customization via
mkdocs.yml
, i.e. the author can provide a list which is composed of allowed keywords to denote the order he wishes:I’m ok without the release number having a link to the release specific URL It’s good just to display the latest release version