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

Fully support Obsidian Callout rendering #40

Closed
sit opened this issue Dec 31, 2024 · 1 comment
Closed

Fully support Obsidian Callout rendering #40

sit opened this issue Dec 31, 2024 · 1 comment

Comments

@sit
Copy link

sit commented Dec 31, 2024

Is your feature request related to a problem?

Obsidian supports a broad range of callouts with different icons and styling for each type. This integration maps those callouts to the smaller set of Starlight Asides.

This means that the output of starlight-obsidian will not match the in-Obsidian or Obsidian Publish view.

Describe the solution you'd like

It would be cool if the Obsidian callout formatting was preserved when mapped into Starlight.

Describe alternatives you've considered

Perhaps it would be possible to build an ObsidianAside component in this integration, and have it override the base Starlight Aside, while preserving the ::: syntax — if using .mdx? Or maybe there's a better way to do that within the existing .md/remark/rehype system.

Additional Context

No response

@HiDeoo
Copy link
Owner

HiDeoo commented Jan 3, 2025

Thanks for the feedback 🙌

The current mapping of Obsidian callouts to Starlight Asides is indeed a best effort. When withastro/starlight#2261 is merged to Starlight, this mapping will be improved icon-wise.

I personally think the difference in styling between Obsidian and Starlight is fine as both are different systems so some differences are expected. However, I'll keep an eye on feedback and if this is a common request, I'll reconsider the approach.

@HiDeoo HiDeoo closed this as not planned Won't fix, can't repro, duplicate, stale Jan 3, 2025
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