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

docs(shortcodes): Add example repository badge #7915

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

niclasheinz
Copy link
Collaborator

Hi @squidfunk

There are some example repositories at https://github.com/mkdocs-material, but these are not listed in the documents. With the new badge, the example repositories can be linked in the documentation.

@squidfunk
Copy link
Owner

Thanks for the PR. Just to knit pick, I'm not really happy with "examplerepo". Also, where would we use it? Could you add suggestions in this PR, so we can learn whether we really want/need this?

@niclasheinz
Copy link
Collaborator Author

niclasheinz commented Jan 18, 2025

I've updated the PR. I thought it would be useful if the existing template repositories from github.com/mkdocs-material were linked in the documentation.

image

@kamilkrzyskow
Copy link
Collaborator

I think it's a good addition to the example, which links to downloadable zip archives.

Likewise to squidfunk I think that the name examplerepo together with Example repository could be improved 🤔.
How about demo and Demonstration, as the repositories could have their own rendered pages?

@niclasheinz
Copy link
Collaborator Author

How about demo and Demonstration, as the repositories could have their own rendered pages?

Good point. That's definitely a better formulation than the one I made.

@squidfunk
Copy link
Owner

+1 for Kamil's proposal!

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

Successfully merging this pull request may close these issues.

3 participants