Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid HTML.
Sketchfab supports Markdown in model descriptions and Annotations.
Primary Markdown Syntax
These are the features most relevant to Sketchfab models.
Images
Will produce
Optionally, you can add alt text and a title (important for SEO and accessibility), like this:
Links
This is [an example](http://example.com/ "Title") inline link.
[This link](http://example.net/) has no title attribute.
This is [an example][id] reference-style link.
Other stuff goes here...
[id]: http://example.com/ "Optional Title Here"
Will produce an example link.
You can make an image that is a link by combining the link code with the image code. Use the image code instead of text:
[](http://example.com)Will produce
Videos
While you can link to a video hosted elsewhere (as described above), you cannot produce a video within your model's description or Annotations by using Markdown.
If you'd like to build a more customized experience with features like embedded videos, it's possible to do on your own website using the Viewer API.
Emphasis
*single asterisks*
_single underscores_
Will produce italic text
**double asterisks**
__double underscores__
Will produce bold text
Titles
This is an H1
=============
This is an H2
-------------
# This is an H1
## This is an H2
###### This is an H6
Lists
Unordered
* Red
* Green
+ Blue
- Yellow
Will produce
- Red
- Green
- Blue
- Yellow
Ordered
1. First item
2. Second item
1. Third item
(The number before the period has no effect on the actual order, it just needs to be a number)
Will produce
- First item
- Second item
- Third item
Other Markdown Syntax
A lot of other Markdown features are supported, but they may not be very useful in the context of Sketchfab models. See this documentation for details:
It's also supported in Help Center comments, although the implementation may not be identical.
Comments
68 comments
Hi, a +1 for controlling the size of the displayed images relative to the viewer. In most of my cases they need to be bigger. Cheers!
@James
I could use 'target="_self" instead of blank' as well.
I am making a game for six year olds:
https://sketchfab.com/models/f518b961f41049ca8ec1378993c2a3d8/embed
And I am going to use a lot of links (like n° 4) for little games (e.g. drawing).
But if the link always creates a new tab, there will be too many tabs at the end of the game (4 levels x 5 links=20!).
This game is part of a bigger project and if all goes well, it will be used by hospitals in Belgium.
Can you help me?
Thank you in advance
Hi there,
I'm afraid it's not possible to force (and not planned to allow) links in Annotations to target _self. Even if it were, the link would open in the embedded iframe itself, not in the main browser tab.
You could build something more custom using the Viewer API, though!
https://sketchfab.com/developers/viewer
Thank you for your answer!
I found a workaround: I gave the little games that open in another tab a 'back' button (for when you are finished playing).
This button closes the tab of the little game, so you go back to the previous tab (sketchfab).
Is it in any way possible that all the annotations are opened at the same time and from te beginning?
I know you can open one with ?annotation = x, but I guess you can only do this with one annotation?
Cool, nice workaround.
I'm afraid only one annotation can be open at a time. An annotation is associated with a camera position, and the camera cannot be in more than one position at the same time :)
Hi! Is it possible to use Markdown to create annotations that are simply a few seconds of audio clips?
@mhogue Hi! I'm afraid there's no support for adding audio or other rich media to annotations at the moment. We do support adding sounds in the viewer, but they currently can't be synced to an annotation.
https://help.sketchfab.com/hc/en-us/articles/115000922746-Sounds
Can I currently create tables using markdown within annotations? I see its possible in the "Extra Markdown Specification" but I cant seem to get it working in the model.
I'm afraid tables are not supported in descriptions or annotations at the moment. What's the use case?
@James The use case would be like the example shown below.
Hello, Is it possible to change the colour of the text in the annotation using markdown?
Not at the moment, sorry!
Hello James,
I would like to know if it's possible to zoom an image so if it has a text you can read it clearly. If not, is there another way?
Thanks!
MANiacos - I've done it where the image itself links to a large view in its own tab using the following syntax:
[ ! [ ] (image url) ] (image url)
Yep, that's exactly what I was going to recommend.
lmendelson James
I've tried and it works! Thanks!
I have just learned how to get images visable in an annotation.
Then I tried to make it clickable by using the syntax [](https://.../../imagename.jpg). The link to the image is still there but the image in the annotation frame is exchange by a boring thumbnail symbol. How to avoid this result?
I found the solution by reading Imendelson´s recipe. Thanks!
Is it Possible to add a annotation with an image as the title to a link?
Sorry I'm not sure I understand the question. You want the image to link somewhere? You want an image in the title of the annotation?
Like in an annotation I want to add links to download a kinda file. I want to have an icon or image of that kinda file and when you click on it, it brings you to the HTML where it will download the file. If that makes sense? Also is there way to link a pdf in an annotation?
Got it. You can link to pretty much anything you want, so you can just host a PDF somewhere and put its URL in the annotation, for example: https://sketchfab.zendesk.com/hc/article_attachments/360078346751/PBR_Guide_2018__20_page_test_.pdf
Thanks, but back to the first question. I want a image or logo of something in the annotation and when you click it, it takes you to an HTML. Sorry Im very new to Sketchfab
No worries! This is more about Markdown syntax in general, not really something specific to Sketchfab.
You make a link in markdown like this:
And you embed an image like this:
So, you can combine these two things to make an image that is a link. Just insert the image instead of Text:
GREAT!! I got it to work, thank you. One last thing, is there a way to make the picture or icon smaller or larger?
Afraid not, it will always just fill the width. For that I might just put a text link "PDF" below the image?
Hi James,
Is it possible to open a link in the annotation in a new popup window instead of a new tab?
Hello,
All links in annotations have the target="_blank" attribute set. That means they will open in a new tab or a new window, but as far as I know, it depends on on your browser settings.
If you want more robust control over the experience. I recommend looking into the Viewer API: https://sketchfab.com/developers/viewer
Here's an example of opening popups on top of the 3D viewer (go through a few steps of the tour, click a furniture item, or click a "Play" object: https://www.sandlerseating.com/neocon
In my annotation, if I wanted to type out #4 Rebar to be Used. How do I get the "#" to show up?
If you put a backslash (`\`) in front of the hash, it should "escape" it and put a literal hash instead of turning it into a markdown header.
Please sign in to leave a comment.