mongodb / specifications

Specifications related to MongoDB
http://specifications.readthedocs.io/en/latest
Other
389 stars 242 forks source link

Use Markdown image instead of HTML image, fixes path on mkdocs #1682

Open mdbmes opened 23 hours ago

mdbmes commented 23 hours ago

This fixes a broken image on the mkdocs / readthedocs build of the Transactions spec. It's the one remaining place where the specs used an HTML image tag inside Markdown.

The image included some custom CSS style to set the size, which explains why it wasn't converted before: but that style is ignored by GitHub. Both the before and after generate effectively the same HTML on GitHub's viewer.

In mkdocs, this increases the image size to the full width of the page (default) and un-breaks the relative path by allowing mkdocs to add an extra "../" component needed to account for the directory containing each rendered Markdown document as an "index.html".