-
Notifications
You must be signed in to change notification settings - Fork 57
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
Migrate Gallery to Catalog #165
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: Oleh Prypin <oleh@pryp.in>
with: | ||
path: gallery | ||
|
||
deploy: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Careful review needed here: I'm not sure deploying to GitHub pages is desirable, given MkDocs documentation is served under its own custom domain.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Deploying it like that would be the same as pushing to a gh-pages
branch here, meaning it would be under https://mkdocs.org/catalog
, assuming the deployment happens on this repository, which is what I assume.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, that's what I'm suspecting too. @tomchristie can you confirm that docs pushed on the gh-pages branch of mkdocs/catalog will end up at www.mkdocs.org/catalog (not that I want to proceed, just want to understand how it works)?
A small thing to consider, but should themes offering multiple variants display all their variants? It could help showing a user the possible options there are. And right now are there at least two themes with such schemes available (Material for MkDocs and the MkDocs theme) |
Interesting point, yes, why not. That would play well with the hosting site which can itself be used in both variants (showing light variants or dark variants depending on the current theme selected by the user browsing the site). Maybe not that useful to display both variants next to each other though (takes more space and we don't have a lot, at least in the catalog, and users can reach the demo and see the variants there for themselves, interactively). |
Migration of the code in https://github.com/pawamoy/mkdocs-gallery.
The code now use the local
projects.yaml
file instead of downloading it from GitHub.@oprypin listed as co-author.
TODO once merged and deployed: update the generator to use URLs from mkdocs.github.io/catalog for theme thumbnails