Markdown

    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.

    Here's an example.

    Primary Markdown Syntax

    These are the features most relevant to Sketchfab models.


    Images

    
    ![](https://website.com/path/to/img.jpg)
    

    Will produce

    Sketchfab logo

    Optionally, you can add alt text and a title (important for SEO and accessibility), like this:

    ![Alt text](https://website.com/path/to/img.jpg "Title")

    
    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.


    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

    1. First item
    2. Second item
    3. 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.

    Have more questions? Submit a request

    Comments

    • Avatar
      yshaya

      Is there any way to adjust the size of images shown in annotations? As I read through the documentation of Markdown I couldn't find such options, but would be happy to know any tricks. 

    • Avatar
      James

      @yshaya - Not at the moment, images will fill with width.

    • Avatar
      bematrix

      This is great to learn! Is it possible to have links and images in the same annotation?

      EDIT: Answered my own question! You can add links, images and plain text in annotation, just watch out for 256 character limit (hint: url shorteners help)

    • Avatar
      James

      @bematrix - Yep! Glad you figured it out :)

      You can also combine the different markdown items together, for example, an image that is a link:

       [![](link/to/img)](link/to/page)

    • Avatar
      Optics_Balzers_AG

      I've thought it would be cool to have one click “Zoom out / Zoom in” function for the images shown in annotations.

    • Avatar
      holliday

      Hi, has there been any progress in adjusting the sizes of images within annotations, or adjusting the sizes of annotation boxes so that larger images can show up using Markdown? We're interested in making the pictures larger for anatomical atlases such as at this page: http://bit.ly/2suXgNl. Thanks

       

    • Avatar
      James

      Hi @holliday,

      I'm afraid there's been no progress on that feature yet. As above, you can create a link to the full version as a workaround.

    • Avatar
      jwillow

      Hi, we're trying to call a functions on the page when the user clicks on an embedded image, like the second notation here: https://sketchfab.com/models/f73caed4328e4af7b5411001ca1a5de5

      Normally markdown allows javascript code, like this:

      [markdown link](javascript:alert("foo");)

      I'm guessing this is not permitted in your markdown? Thanks.

    • Avatar
      James

      Hi @jwillow

      Sorry, that's correct. JavaScript is not permitted in our Markdown implementation. It would represent to great a security risk.

    • Avatar
      MakaroniSiri

      Hi, I was wondering if it was possible to embed images from files? Is it a must to add an html link, or is it possible to create one for the image?

      Thanks : )

    • Avatar
      James

      Hi,

      We don't support uploading your own image files. You'll need to host the image somewhere else (e.g. Imgur)