Suggested way to make markdown image with crossref label.

[arbipher]

Hi developers,

I was using hybrid mode following some overleaf tutorials, but I can't figure out the correct way to cross-ref them.

\setkeys{Gin}{width=\linewidth}
![dvn1](Paul_Gauguin_-_D'ou_venons-nous.jpg "Where Do We Come From? What Are We? Where Are We Going?")

I tried figuring it out locally and here is the snippet from the lualatex output

{}\markdownRendererImage{dvn1}{asset/Paul_Gauguin_-_D'ou_venons-nous.jpg}{asset/Paul_Gauguin_-_D'ou_venons-nous.jpg}{Where Do We Come From? What Are We? Where Are We Going?}\markdownRendererInterblockSeparator

The manuals show \markdownRendererImage takes four arguments and the 1st is the label, however, I cannot use \ref{dvn1} to correct cross-ref it.

Meanwhile, the heavy-tex way make it correct

\begin{figure}[H]
    \setkeys{Gin}{width=\linewidth}
    ![Where Do We Come From? What Are We? Where Are We Going?](Paul_Gauguin_-_D'ou_venons-nous.jpg)
    \caption{Where Do We Come From? What Are We? Where Are We Going?}
    \label{fig:dvn0}
\end{figure}

p.s. as for the soft-deprecated hybrid, I also didn't figure out what should be the correct option to use my above first snippet.

[Witiko]

Hi and thanks for using the Markdown package!

You may use the option linkAttributes, which would allow you to specify an image identifier as follows:

\setkeys{Gin}{width=\linewidth}
![dvn1](Paul_Gauguin_-_D'ou_venons-nous.jpg "Where Do We Come From? What Are We? Where Are We Going?"){#fig:dvn0}

p.s. as for the soft-deprecated hybrid, I also didn't figure out what should be the correct option to use my above first snippet.

You may use the option rawAttribute in as follows:

`\setkeys{Gin}{width=\linewidth}`{=tex}
![dvn1](Paul_Gauguin_-_D'ou_venons-nous.jpg "Where Do We Come From? What Are We? Where Are We Going?"){#fig:dvn0}

or:

``` {=tex}
\setkeys{Gin}{width=\linewidth}
```
![dvn1](Paul_Gauguin_-_D'ou_venons-nous.jpg "Where Do We Come From? What Are We? Where Are We Going?"){#fig:dvn0}

Compared to the hybrid option, this has the advantage of cleanly separating the Markdown document from LaTeX commands.

However, a cleaner approach is to place the \setkeys command outside the Markdown document in the LaTeX preamble to avoid embedding raw LaTeX altogether.

Let me know if you need further clarification or examples!

[arbipher]

Hi, thanks for your timely and detailed answer.

For my first question, it doesn't solve the label problem. With your fix, now the generated markdown is

\markdownRendererAttributeIdentifier{fig:dvn1}\markdownRendererImage{dvn1}{dvn.jpg}{dvn.jpg}{Where Do We Come From? What Are We? Where Are We Going?}\markdownRendererImageAttributeContextEnd{}\markdownRendererParagraphSeparator

However, I tried fig:dvn1 as many variants as the label in \ref{}, not none of them worked. Is there any way I can see the compiled tex file output for my markdown input.

[Witiko]

For my first question, it doesn't solve the label problem.

It works for me:

\documentclass{article}
\usepackage[linkAttributes]{markdown}
\begin{document}
\begin{markdown}
![example-image](example-image.pdf "Example image title"){#example-id}
\end{markdown}
See Figure \ref{example-id}.
\end{document}

Your issue may be related to the document class / other packages you are using. Can you please demonstrate your issue with a minimal document that I can compile?

Is there any way I can see the compiled tex file output for my markdown input.

There is no "compiled TeX file output" other than what you listed. The commands \markdownRenderer... are interpreted dynamically during TeX's run. You can see the definitions of these commands in the file markdownthemewitiko_markdown_defaults.sty that is installed together with the Markdown package:

\seq_new:N
  \l__markdown_image_identifiers_seq
\markdownSetup {
  rendererPrototypes = {
    imageAttributeContextBegin = {
      \group_begin:
      \markdownSetup {
        rendererPrototypes = {
          attributeIdentifier = {
            \seq_put_right:Nn
              \l__markdown_image_identifiers_seq
              { ##1 }
          },
        },
      }
    },
    imageAttributeContextEnd = {
      \group_end:
    },
    image = {
      \tl_if_empty:nTF
        { #4 }
        {
          \begin { center }
            \includegraphics
              [ alt = { #1 } ]
              { #3 }
          \end { center }
        }
        {
          \begin { figure }
            \begin { center }
              \includegraphics
                [ alt = { #1 } ]
                { #3 }
              \caption { #4 }
              \seq_map_inline:Nn
                \l__markdown_image_identifiers_seq
                { \label { ##1 } }
            \end { center }
          \end { figure }
        }
    },
  }
}