Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[unknown div] Warnings in pull requests #53

Open
martinosorb opened this issue May 18, 2023 · 1 comment
Open

[unknown div] Warnings in pull requests #53

martinosorb opened this issue May 18, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation {pegboard} validator R package

Comments

@martinosorb
Copy link

martinosorb commented May 18, 2023

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 zkamvar changed the title Warnings in pull requests [unknown div] Warnings in pull requests May 18, 2023
@zkamvar
Copy link
Contributor

zkamvar commented May 18, 2023

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: carpentries/sandpaper#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 😨.

@zkamvar zkamvar added {pegboard} validator R package documentation Improvements or additions to documentation labels Jun 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation {pegboard} validator R package
Projects
None yet
Development

No branches or pull requests

2 participants