badlydrawnrob / print-first-css

Other
0 stars 0 forks source link

Adding html to markdown files #18

Open badlydrawnrob opened 5 years ago

badlydrawnrob commented 5 years ago

Sketch out the pros and cons, as well as the workflow options

Markdown is a simple formatting method, so it's probably best not to get too clever when writing and formatting ... but when adding HTML, current difficulties:

Pandoc allows the following syntax to wrap with a div:

::: {#special}
text goes here
:::

Code example:

<div class="split"><div class="split-left">

- list
- of
-stuff

</div><div class="split-right">

Content

</div></div>

Need to decide whether it's best to:

  1. [ ] Use Markdown for full pages (with HTML inside file)
  2. [ ] Use Markdown for partials (and a templating language)
  3. [ ] Use Markdown with frontmatter
  4. [ ] Use javascript to style some elements (the introduction, for instance)

HTML inside Markdown is easy(ish) to compile, and if done right can provide some flexibility (such as figcaption etc) — but feels a bit hacky, somehow.

Perhaps there's a balance between building a structure and using markdown files, within that structure.