Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Image markdown not working #212

smono opened this Issue Apr 21, 2012 · 3 comments


None yet
2 participants

smono commented Apr 21, 2012

The markdown syntax documentation mentions (here: http://daringfireball.net/projects/markdown/syntax#img ) that an image can be included in the page with for instance the following syntax:

![Alt text](/path/to/img.jpg "Optional title")

The following test case illustrates this:

Create a file with the following contents and include it with the --include option:

Image in markdown


Some text.

![Proposal for the New Circle](./circle.jpg "Proposal for the new circle.")

More text.

In the output, the exclamation mark is visible, and the link is a normal link to the external file.

smono commented Apr 21, 2012

Oh, forgot to add that the file has -template in its name to ensure that markdown works, which it does for other things, such as the headers.


tomaz commented Apr 21, 2012

Could be appledoc preprocesses the text and takes the part after exclamation as normal link. Currently there are lots of dependencies especially inside Markdown handling - the code was patched several times so it's quite messy. I'm working on major refactoring of the project and have already experimented with alternative Markdown library that implements callbacks when various elements are parsed. See this blog post where I describe it in bit more detail.


tomaz commented May 17, 2013

Closing this issue in favor of #323; there's more info and possible solution there.

@tomaz tomaz closed this May 17, 2013

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment