Jump to content

Issue #23 when to use the different styled notes?


Calhavintas

Recommended Posts

Hi there,

 

the issue #23 on github mentions the use of the styled notes (note, warning, info, success, important), but doesn't explain under which circumstances they should by applied.

 

Warning may be the easiest: if some error or crash appears in-game.

 

The meaning of the others are a little bit blurry to me ???

Link to comment

Then i would stick with these two for the moment, unless it's clear from the description, that they don't match well.

 

Regarding this code snippet (found in op001.html)

{{site.game}}

should this be included in the note or removed or placed elsewhere?

 

UPDATE:

is this the correct notation for multiple notes:

{% capture note %}
First Note
{% endcapture %}

{% include note.html %}

{% capture note %}
First warning
{% endcapture %}

{% include warning.html %}

{% capture note %}
Second Note
{% endcapture %}

{% include note.html %}

?

Link to comment

That particular one looks extraneus and is evaluated to an empty string anyway.

 

Notes: yes. Even if two notes of the same type follow each other (and it makes sense not to merge them), you need two includes.

Link to comment

Archived

This topic is now archived and is closed to further replies.

×
×
  • Create New...