Images in subpages named index.md have the incorrect path on Windows/cygwin

[styfle]

I am using the following markdown in index.md and running mkdocs serve

## Diagram
This is the svg
![svg](diagram.svg)

The output is correct

<img alt="svg" src="./diagram.svg" /></p>

However I get a broken image as seen below

It appears that the svg file is served as application/octet-stream instead of the expected image/svg+xml

[d0ugal]

Interesting. Can you try with this option and let me know if that solves the svg issue?

mkdocs serve --no-livereload

[styfle]

@d0ugal I tried and it does not solve the issue.

[d0ugal]

Interesting, I tried with a random SVG I found online and the response headers stated Content-Type:image/svg+xml but the image was still broken. This happened with and without livereload enabled.

[d0ugal]

Ah, I tried again with another SVG file and it worked fine with and without livereload. The content type was correct and the image rendered.

Can you let me know your mkdocs version? Either with mkdocs --version or pip freeze | grep mkdocs

[waylan]

As livereload is a simple wrapper around tordano's static file server, I checked and tordano seems to only ever have had one relevant issue filed regarding SVG (tornadoweb/tornado#1637). And according to that issue, SVG files have always been served as image/svg+xml. Not sure why any would be served as application/octet-stream. All that PR did was add SVG to the list of types that get GZip compression and it appears to have not made it into a release yet. And livereload has never had any SVG related issues filed.

@styfle all I can suggest is to make sure you are using the latest release of livereload, tornado, and MkDocs.

[d0ugal]

Yeah, my best guess is that it is a really old MkDocs from when we hacked together out own server.

[styfle]

@d0ugal @waylan I'm using the latest as far as I can tell.

$ python --version
Python 2.7.10

$ pip --version
pip 8.0.2 from /usr/lib/python2.7/site-packages (python 2.7)

$ mkdocs --version
mkdocs, version 0.15.3

[styfle]

I'm running on Windows 10 with Cygwin.
Here is the pip packages which might be useful.
It looks like the latest version of tornadoweb.

$ ls -lA /usr/lib/python2.7/site-packages
total 412
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 11:33 _markerlib
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 alabaster
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 alabaster-0.7.7.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 babel
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 Babel-2.2.0.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 backports
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 backports.ssl_match_hostname-3.5.0.1.dist-info
-rw-r--r--  1 styfle Domain Users  5277 Feb 24 13:23 backports_abc.py
-rw-r--r--  1 styfle Domain Users  6564 Feb 24 13:23 backports_abc.pyc
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 backports_abc-0.4.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 certifi
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 certifi-2015.11.20.1.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 click
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 click-6.3.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 14:40 CommonMark
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 14:40 CommonMark-0.5.4.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 11:57 django
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 11:57 Django-1.9.2.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 docutils
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 docutils-0.12.dist-info
-rw-r--r--  1 styfle Domain Users   126 Feb 24 11:33 easy_install.py
-rw-r--r--  1 styfle Domain Users   315 Feb 24 11:33 easy_install.pyc
-rw-r--r--  1 styfle Domain Users   226 Feb 24 11:47 easy-install.pth
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 jinja2
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 Jinja2-2.8.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 livereload
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 livereload-2.4.1.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 markdown
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 Markdown-2.6.5.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 markupsafe
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 MarkupSafe-0.23.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 mkdocs
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 mkdocs_bootstrap
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 mkdocs_bootstrap-0.1.1.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 mkdocs_bootswatch
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 mkdocs_bootswatch-0.3.1.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 mkdocs-0.15.3.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 11:33 pip
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 11:33 pip-8.0.2.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 11:33 pkg_resources
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 pygments
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 Pygments-2.1.1.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 pytz
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 pytz-2015.7.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 PyYAML-3.11.dist-info
-rw-r--r--  1 styfle Domain Users   119 Jun  1  2015 README
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 11:47 readthedocs-1.0-py2.7.egg
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 14:40 recommonmark
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 14:40 recommonmark-0.4.0.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 11:33 setuptools
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 11:33 setuptools-20.1.1.dist-info
-rw-r--r--  1 styfle Domain Users  8292 Feb 24 13:23 singledispatch.py
-rw-r--r--  1 styfle Domain Users  8023 Feb 24 13:23 singledispatch.pyc
-rw-r--r--  1 styfle Domain Users  5228 Feb 24 13:23 singledispatch_helpers.py
-rw-r--r--  1 styfle Domain Users  8574 Feb 24 13:23 singledispatch_helpers.pyc
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 singledispatch-3.4.0.3.dist-info
-rw-r--r--  1 styfle Domain Users 30098 Feb 24 12:02 six.py
-rw-r--r--  1 styfle Domain Users 29545 Feb 24 12:02 six.pyc
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 six-1.10.0.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 snowballstemmer
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 snowballstemmer-1.2.1.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 sphinx
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 sphinx_rtd_theme
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 sphinx_rtd_theme-0.1.9.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 12:02 Sphinx-1.3.5.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 tornado
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 tornado-4.3.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 11:33 wheel
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 11:33 wheel-0.29.0.dist-info
drwxr-xr-x+ 1 styfle Domain Users     0 Feb 24 13:23 yaml

[d0ugal]

Interesting. Then my new best guess is that this is Windows related. All the versions you are using otherwise are known to be good o think.

[waylan]

I just tried this on Windows 7 and was not able to reproduce the problem.

I got the following response (which works fine):

HTTP/1.1 200 OK
Date: Fri, 26 Feb 2016 17:09:09 GMT
Content-Length: 10009
Etag: "eb2a8759ddf38da50f60feb11f7208f5ec11daac"
Content-Type: image/svg+xml
Server: TornadoServer/4.1

And I have the following installed:

livereload==2.3.2
tornado==4.1
mkdocs==0.15.3

[d0ugal]

Hmm, odd. @styfle Have you tried this with a different SVG file just to ceck it isn't broken?

[styfle]

@d0ugal @waylan
You know, my initial post was incorrect. I said that <img alt="svg" src="./diagram.svg" /></p> is the correct output when in fact the output should be the relative path <img alt="svg" src="diagram.svg" /></p>

Is my markdown wrong? What's the proper way to include an image relative to the current md file?

[waylan]

What happens when you try to load the URL for the SVG file directly? Try going directly to http://127.0.0.1:8000/diagram.svg. Does that work properly?

It should simply display your SVG file in the browser. If it does anything else, then the problem is with the SVG file. If it works fine, then the problem is something else.