Skip to content

Commit

Permalink
Update description.vto
Browse files Browse the repository at this point in the history
  • Loading branch information
luke-strange committed Sep 10, 2024
1 parent a8be140 commit ddcc7e2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/_includes/content/description.vto
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<a href="https://open-innovations.github.io/housing/data/explorations/">documenting some of our code</a> using
jupyter notebooks. In summary:
<ul>
<li>If you have a <code>jupyter notebook</code> and you want to put it on a <code><a href="/">Lume</a></code> site, you need to convert it to a format <code>Lume</code> knows about.</li>
<li>If you have a <code>jupyter notebook</code> and you want include the result on a <code><a href="/">Lume</a></code> site, you need to convert it to a format <code>Lume</code> knows about.</li>
<li>You can automatically convert notebooks to <code>markdown</code> with <code>jupyter <a href="https://nbconvert.readthedocs.io/en/latest/usage.html">nbconvert</a></code>. </li>
<li>However, if you then want to include other elements like <code><a href="https://open-innovations.github.io/oi-lume-viz/samples/">OI Lume charts</a></code> or parts of other pages using <code>{{ "{{ includes }}" |> escape }}</code> tags, you need a <code><a href="https://vento.js.org/">.vento</a></code> (or <code>.njk</code>) file.</li>
<li>This tool converts the <code>markdown</code> format to <code>vento</code>, preserving things like front matter, and various <code>HTML</code> tags. It adds <code>{{ "<p>" |> escape }}</code> tags to sentences and formats any code blocks correctly so that they can be styled using the <code><a href="https://lume.land/plugins/prism/">prism</a></code> plugin. </li>
Expand Down

0 comments on commit ddcc7e2

Please sign in to comment.