Skip to content

refactor: use an <article> element for for package readme #524

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.

Sign up for GitHub

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

Merged
danielroe merged 3 commits into from
Jan 31, 2026
Merged

refactor: use an <article> element for for package readme #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e865229
refactor: use an `<article>` element for for package readme
knowler Jan 31, 2026
b671b9a
refactor: set article on the readme contents itself
knowler Jan 31, 2026
7b007fb
refactor: remove `<aside>` element used for sidebar
knowler Jan 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions app/components/PackageSkeleton.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@
</div>

<!-- Sidebar: order-1 lg:order-2 space-y-8 -->
<aside class="order-1 lg:order-2 space-y-8">
<div class="order-1 lg:order-2 space-y-8">
<!-- Maintainers -->
<section>
<h2
Expand Down Expand Up @@ -249,7 +249,7 @@
</li>
</ul>
</section>
</aside>
</div>
</div>
</article>
</template>
6 changes: 3 additions & 3 deletions app/pages/[...package].vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -907,7 +907,7 @@ function handleClick(event: MouseEvent) {
</a>
</h2>
<!-- eslint-disable vue/no-v-html -- HTML is sanitized server-side -->
<div
<article
v-if="readmeData?.html"
class="readme-content prose prose-invert max-w-[70ch]"
v-html="readmeData.html"
Expand All @@ -923,7 +923,7 @@ function handleClick(event: MouseEvent) {

<div class="area-sidebar">
<!-- Sidebar -->
<aside class="sticky top-20 space-y-6 sm:space-y-8 min-w-0 overflow-hidden">
<div class="sticky top-20 space-y-6 sm:space-y-8 min-w-0 overflow-hidden">
<!-- Maintainers (with admin actions when connected) -->
<PackageMaintainers :package-name="pkg.name" :maintainers="pkg.maintainers" />

Expand Down Expand Up @@ -1031,7 +1031,7 @@ function handleClick(event: MouseEvent) {
:peer-dependencies-meta="displayVersion.peerDependenciesMeta"
:optional-dependencies="displayVersion.optionalDependencies"
/>
</aside>
</div>
</div>
</article>

Expand Down
Loading