Stream: IG creation
Topic: Markdown flavor
Keith Boone (Feb 20 2020 at 04:39):
What flavor of markdown is supported by the IG Builder? I know we are using Jekyll to convert to HTML, but I don't know how IG Builder is configured to send stuff to Jekyll to handle conversion from Markdown.
Grahame Grieve (Feb 20 2020 at 04:44):
CommonMark
Keith Boone (Feb 20 2020 at 04:45):
Thank you!
Eric Haas (Feb 20 2020 at 18:24):
actually Jekyll supports kramdown which I use all the time in the ig pages NOT in the FHIR artifacts.
Frank Oemig (Apr 09 2020 at 17:58):
How do I reference images?
The rendered pages look strange. Without size they are too big, with size the text flows around...
Jose Costa Teixeira (Apr 09 2020 at 18:09):
@Frank Oemig does this help?
https://chat.fhir.org/#narrow/stream/179252-IG-creation/topic/Sample.20IG.20-.20Images.20Override/near/187758367
Frank Oemig (Apr 09 2020 at 18:28):
Don't know why, but yes - thx.
It still reports missing images although they are shown. But I can live with that.
Grahame Grieve (Apr 09 2020 at 20:25):
It still reports missing images
can you be precise? what's the error?
Rob Hausam (Apr 10 2020 at 03:02):
Yes, I also found that <br clear="all"/> does work. I think that's supposed to be deprecated, though. I also discovered that <div style="clear:both;"></div> does the same (and seems to be more up to date). This is how we're implementing it now in IPS (since we moved to the new template) with this as img.html in the 'includes' folder:
<p><strong>{{include.caption | default: ""}}</strong></p>
<img src="{{include.img}}" class="figure-img img-responsive img-rounded center-block"
alt="{{include.caption}}" style="width:{{include.width}}">
<div style="clear:both;"></div>
and an example of Jekyll syntax to include it in a page:
{% include img.html img="IPS_doc_library.png" caption="Figure 1: The IPS product and by-products" width="70%" %}
Frank Oemig (Apr 10 2020 at 06:28):
Background for my problems:I have intensive text with lots of images. MD seems easier than Html.
Referencing images resulted in lots of problems. Some are fixed with an update and br elements.
Working with html and MD is different. In html I have to include a-elements before each heading, otherwise text is fully hyperlinked.
In MD images are causing indentation w/o br elements. And headings disappear although they are listed in small top right box.
My believe is that CSS apply some surprising formattings...
I need to check that further...
Frank Oemig (Apr 10 2020 at 06:30):
@Rob: does this work in MD?
Rob Hausam (Apr 10 2020 at 13:01):
@Frank Oemig Yes, this is what we are using in our markdown pages.
Rob Hausam (Apr 10 2020 at 13:03):
I just figured this out earlier this week when we made the switch to the new template. But it looks good and seems to be working as expected.
Rob Hausam (Apr 10 2020 at 15:24):
I will mention that before we moved to the new template we were using the <figure> tag to encapsulate the images in the img.html file that we include in the markdown pages. But once we moved to the new template, the <figure> tag is no longer working (not sure why that should be, and obviously that's another issue, but so far I haven't pursued it). So instead I found and we've moved to the solution above, which accomplishes the same thing and is working correctly with the new template.
Last updated: Apr 12 2022 at 19:14 UTC
