QwikDev / QwikDev/qwik

[📖] Add a blog index page with all blog posts to the qwik city demo

Open
#3,796 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs good first issue PR welcomed
Dominant language
TypeScript
Stars
22.1k
Forks
1.4k
Avg merge
1d 10h
Merged PRs (30d)
52

Description

Suggestion

It's not documentation per se but rather a change in the demo qwik city app.

When writing blogs with mdx, we need an index or category page to show blog post lists.

Problem

How to create such a page needs to be clarified, especially if you're unfamiliar with Vite's import.meta.glob. The current state may lead to uncertainty and wasted time, or even abandonment in the worst cases.

Resolution

Add a blog/index.ts with a few mdx blog posts that implement the import.meta.glob to the features section of the qwik city demo app.

Discussion

I would add:

  1. Three three blog posts, two mdx, and one md
  2. An index file that'll glob and order them by published date - not sure about how to implement this yet
  3. A JSX component that will render in the mdx files.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the features section of the Qwik City demo app and inspect the proposed blog/index.ts entry point. Review Vite's import.meta.glob documentation, then determine how the three MDX/MD posts should expose publication dates and how a JSX component will render them. Done means the demo includes an index listing the posts in published-date order and the posts render their component.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, typescript
Domain
frontend, web-dev
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.