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

Example gallery-like structure to see all plots at a glance #36

Open
asinghvi17 opened this issue Mar 20, 2023 · 5 comments
Open

Example gallery-like structure to see all plots at a glance #36

asinghvi17 opened this issue Mar 20, 2023 · 5 comments

Comments

@asinghvi17
Copy link
Member

e.g. https://texample.net does this, where you can see a preview of each example on a single page, then click on it. We used to have that in MakieGallery as well, which is still up at https://juliaplots.github.io/MakieReferenceImages/gallery !

It would be great to have something like that here, as a welcoming front page. We could also possibly incorporate the documentation example plots in here, by parsing the docs!

@asinghvi17
Copy link
Member Author

Here's a list of todos which should encapsulate exactly what has to happen here:

  • adding the reference tests as their own category, so they're still integrated and searchable but somewhat separate.
  • enforcing the BeautifulMakie Literate.jl programming style for longer examples, which is really good.
  • allowing multiple tags.
  • creating the front page as a searchable, scrollable gallery, which has elements that redirect you to the appropriate page when clicked on.

In general, examples should:

  1. Work when copy-pasted. That means that most assets should be located in the Makie monorepo, within reason, or accessed through Downloads.download.
  2. Be (mostly) backend-independent, i.e. using Makie.* instead of GLMakie.*.
  3. Not visibly call functions which affect global state, i.e., activate!, unless necessary (these should be hidden)
  4. There should be an interface where examples can declare their tags, and some autogeneration should be done, for example to show the package versions.

@lazarusA
Copy link
Collaborator

For the gallery overview I think we should follow the idea from here. Here is the issue I opened but never acted on it 😄 . As for the other points, most are already covered, I think.

@asinghvi17
Copy link
Member Author

DemoCards.jl should be able to do that with a few tweaks...

@lazarusA
Copy link
Collaborator

lazarusA commented May 11, 2024

mmm... now I do have a vue component that handles the into gallery. My issue has been to get all paths and structure programmatically, maybe this could help. Or, replace it.

@asinghvi17
Copy link
Member Author

asinghvi17 commented May 11, 2024

Oh yeah, we could definitely add a vue component style to DemoCards (it could even be done on our end so we don't have to wait for a PR there)!

I was actually looking for something like this, forgot to check BeautifulMakie :D

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

No branches or pull requests

2 participants