carpentries / workbench

Repository for Discussions and Materials about The Carpentries Workbench
https://carpentries.github.io/workbench/
Creative Commons Attribution 4.0 International
17 stars 7 forks source link

`[unknown div]` Warnings in pull requests #53

Open martinosorb opened 1 year ago

martinosorb commented 1 year ago

I'm not sure what causes this and I was told by @zkamvar that this is harmless, but putting it here in case others have the same question.

When looking at pull requests that have been reviewed by Github actions, there are many warnings related to divs, which look like

Check warning on line 340 in episodes/01-run-quit.md
GitHub Actions / Build markdown source files if valid

[unknown div] row

See for example here.

zkamvar commented 1 year ago

This is a normal. The Workbench automatically checks for accessible links (which should be fixed) and if there are any unknown type of fenced div (here is a list of the known divs: https://carpentries.github.io/sandpaper-docs/component-guide.html).

The latter check was implemented last year by request because people were finding that typos were running uncaught: https://github.com/carpentries/sandpaper/issues/254

The reason why your lesson produces these div warnings is because it uses HTML divs to create two-column content:

<div class="row">

  <div class="col-md-6" markdown="1">

*   Use asterisks
*   to create
*   bullet lists.

  </div>

I could be argued that these div classes should be included in the list of known divs, but it's something for the future.

I realize only now that I never documented them anywhere in the main documentation 😨.