You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The website is structured in a hard-coded way with some HTML semantic tags: the <header> contains a <nav>, all rendered markdown content is wrapped inside a <main> section, and a <footer> closes the page body, all parts in correct tags for their purposes. But inside the <main> part, the rendered markdown is, basically, a simple conversion of symbols (eg. # [text] wraps [text] in a level 1 heading), with the renderer not aware of the context of these symbols, which could be considered to make use of HTML sectioning elements, too, when appropriate.
For a few examples, a level 2 heading and its pertaining paragraphs (and any other elements) could be wrapped in an <article> element. A level 2 heading with lower level headings could be wrapped in a <section> element, with the lower level headings inside an <article>. A table of contents could be in a <nav>.
The examples above reflect what the GrapheneOS website uses in the FAQ page:
Other pages use different nesting schemes of article and section elements, and I couldn't really distinguish why.
This can be automated if a solid recommendation can be followed, but should require using (finding or creating) Jekyll plugins to modify the way markdown pages are rendered. Tho, creating plugins for tasks like these is easy and shouldn't require much maintenance.
The text was updated successfully, but these errors were encountered:
The website is structured in a hard-coded way with some HTML semantic tags: the
<header>
contains a<nav>
, all rendered markdown content is wrapped inside a<main>
section, and a<footer>
closes the page body, all parts in correct tags for their purposes. But inside the<main>
part, the rendered markdown is, basically, a simple conversion of symbols (eg.# [text]
wraps[text]
in a level 1 heading), with the renderer not aware of the context of these symbols, which could be considered to make use of HTML sectioning elements, too, when appropriate.For a few examples, a level 2 heading and its pertaining paragraphs (and any other elements) could be wrapped in an
<article>
element. A level 2 heading with lower level headings could be wrapped in a<section>
element, with the lower level headings inside an<article>
. A table of contents could be in a<nav>
.The examples above reflect what the GrapheneOS website uses in the FAQ page:
![Image](https://private-user-images.githubusercontent.com/103858681/406194769-6b667b63-069b-4553-ab97-e89e697b9b62.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkwMDg3NTQsIm5iZiI6MTczOTAwODQ1NCwicGF0aCI6Ii8xMDM4NTg2ODEvNDA2MTk0NzY5LTZiNjY3YjYzLTA2OWItNDU1My1hYjk3LWU4OWU2OTdiOWI2Mi5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjUwMjA4JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI1MDIwOFQwOTU0MTRaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT02MjFhZWRiODYyYmRlMjY5YzA2YTc3OTMwNTczODlhODJkYjliOWUyMDEwNWVmZWQ4YmEyMjZiN2VkNTNjOTAyJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.sMNbXkMvzWX2BtS8P6mTyAH90JkpwrBmoWaZe5JrozI)
Other pages use different nesting schemes of article and section elements, and I couldn't really distinguish why.
This can be automated if a solid recommendation can be followed, but should require using (finding or creating) Jekyll plugins to modify the way markdown pages are rendered. Tho, creating plugins for tasks like these is easy and shouldn't require much maintenance.
The text was updated successfully, but these errors were encountered: