DjangoGirls / tutorial-extensions

Additional tasks for tutorial
https://tutorial-extensions.djangogirls.org
Other
162 stars 202 forks source link

Remove GitBook {% raw %}...{% endraw %} crutches #156

Closed shaib closed 9 months ago

shaib commented 1 year ago

In the past, this tutorial was rendered with GitBook. This is now being changed to Honkit (the JS changes to support this have already been committed).

With GitBook, inline code snippets needed to be surrounded by {% raw %} ... {% endraw %}, and so these tags are in current texts.

With Honkit, they need not to be, and if they are, the {% raw %} and {% endraw %} tags end up rendered into the page.

das-g commented 1 year ago

I'm pretty sure {% raw %} and {% endraw %} are sometimes also needed in HonKit, as we also use them in the main Django Girls tutorial, which has been using HonKit instead of GitBook for quite some time now. Maybe the cases where they are or aren't needed are subtly different between GitBook and HonKit?

shaib commented 1 year ago

Is it possible that Honkit is only used for local development? In the file I am working on (homework/README.md) every single one of them was rendered.

spignelon commented 9 months ago

For reference:

image

das-g commented 9 months ago

Seem like the difference is whether the {% raw %} and {% endraw %} template tags occur inside or outside of `…` backquotes. See #169 for a partial fix and #170 for a complete fix.