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

Add more examples + a basic metadata framework #233

Merged
merged 25 commits into from
Jun 8, 2024
Merged

Conversation

asinghvi17
Copy link
Member

@asinghvi17 asinghvi17 commented Jun 7, 2024

https://geo.makie.org/previews/PR233
The metadata framework doesn't apply to anything yet, but it should do so quite soon! I will have to guard against garbage collection somehow, though. Maybe by setting the value of cover to the relevant module?

The actual implementation will come in the next PR.

@asinghvi17 asinghvi17 changed the title Update index.md Implement the example gallery via Documenter directly + add Documenter blocks Jun 8, 2024
@asinghvi17
Copy link
Member Author

@lazarusA you might be interested in examples/basic.jl and docs/example_meta_block.jl here - they have a first prototype for in-code evaluation of an example's metadata (title, description, cover) which we can forward to the Gallery prototype here. (Just have to figure out how to embed/downsize the image now :D)

@asinghvi17 asinghvi17 changed the title Implement the example gallery via Documenter directly + add Documenter blocks Add more examples + a basic metadata framework Jun 8, 2024
@asinghvi17
Copy link
Member Author

asinghvi17 commented Jun 8, 2024

TODOs for the next PR:

  • Make the @cardmeta block rewrite the page to add the cover image directly after the first title element
  • Create a constructor for a Card object that populates values from the Dict GALLERY_DICT
  • Make this constructor also downsize the cover image by a factor of at least 3, for a lighter page
  • Get the example gallery working again!
  • Allow multiple cardmeta blocks on a single page
  • Stretch goal: at the end of each page, try to add a default Cover = fig, without the user having to write it...

@asinghvi17 asinghvi17 merged commit dc70cc3 into master Jun 8, 2024
2 checks passed
@asinghvi17 asinghvi17 deleted the asinghvi17-patch-2 branch June 8, 2024 23:58
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.

1 participant