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

fix(docs): fix image not rendering #775

Merged
merged 2 commits into from
Feb 2, 2025
Merged

Conversation

SkeleyM
Copy link
Contributor

@SkeleyM SkeleyM commented Feb 2, 2025

image wasn't showing in the docs

@CyanVoxel
Copy link
Member

Interesting, the images already show up fine for me? 🤔

image

@SkeleyM
Copy link
Contributor Author

SkeleyM commented Feb 2, 2025

how odd, I noticed this not working when checking the documentation on GitHub, maybe its due to my browser? however this also happens for me when rendering it in visual studio code
image

@CyanVoxel
Copy link
Member

how odd, I noticed this not working when checking the documentation on GitHub, maybe its due to my browser? however this also happens for me when rendering it in visual studio code image

VSCode also doesn't render it properly for me, though that's likely due to MKDocs using such a weird syntax here which combines markdown and HTML. Although now that I try applying the change you made, it renders? Which kind of makes sense but also not really?

Formatting with Prettier also wants it to add an extra space in-between the markdown embed and the figcaption tag:

<figure width="60%" markdown="span">

![TagStudio screenshot](assets/screenshot.png)

<figcaption>TagStudio Alpha v9.5.0 running on macOS Sequoia.</figcaption>

</figure>

@CyanVoxel CyanVoxel added Type: Bug Something isn't working as intended Type: Documentation Additions/changes to documentation labels Feb 2, 2025
@SkeleyM
Copy link
Contributor Author

SkeleyM commented Feb 2, 2025

combining html and markdown causes all kinds of weird quirks sometimes, ill add the extra space in-between the figcaption tag

@CyanVoxel CyanVoxel merged commit f212e23 into TagStudioDev:main Feb 2, 2025
5 checks passed
@SkeleyM SkeleyM deleted the fix_docs branch February 2, 2025 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug Something isn't working as intended Type: Documentation Additions/changes to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants