Initialising Chirpy themed Blogs using GitHub Pages

[AdarshRawat1]

Fixes

• Set up static site generation infra for project blog post preview #46

Blog files are stored under the _posts directory. Other files belong to the Chirpy theme.

Demo - https://adarshrawat1.github.io/P4-GSoC-preview/

This prototype may have a few minor issues related to relative links or file paths. I’ll raise follow-up fixes after this is merged.

Few Limitations

• Each blog page must have the date in the file name, e.g. 2025-10-10-README.md (format: yyyy-mm-dd-<name>.md). Couldn’t find a workaround yet.
• Titles cannot contain : unless wrapped in quotes due to YAML parsing limits. Use - instead if needed.
• Relative asset paths (like ./assets/img.png ) do not render correctly in the Chirpy theme. Use full GitHub URLs or embed the assets directly in the Markdown.
• The auto-generated header in README.md appears in GitHub’s preview and may not look clean. This is fine since the main goal is the blog site view.

[Dscano]

Thank you so much, @AdarshRawat1. Would it be possible to rework the folder organization?

The folder structure you proposed changes the logic we defined for the GSoC repo. Ideally, we would like to keep the current GSoC folder organization, and place the files needed for blog generation in a dedicated folder under gsoc/.

Do you have a link where we can see the blog?

[AdarshRawat1]

Thank you so much, @AdarshRawat1.

He he 🌻

Would it be possible to rework the folder organization?
The folder structure you proposed changes the logic we defined for the GSoC repo. Ideally, we would like to keep the current GSoC folder organization, and place the files needed for blog generation in a dedicated folder under gsoc/.

I was aware of this challenge. I tried but it was not possible with this theme, as I mentioned earlier .. @qobilidop 's Suggestion of having a layer of redirection should help.

Do you have a link where we can see the blog?

Here is the demo link - https://adarshrawat1.github.io/P4-GSoC-preview/

[AdarshRawat1]

I've retained the previous repository structure to avoid breaking GSoC project link.

Like

• https://summerofcode.withgoogle.com/archive/2024/projects/sYbpOJhD
• linking to - https://github.com/p4lang/gsoc/blob/main/2024/projects/container_migration/README.md)

And for the new projects we can have redirection wiki.

[qobilidop]

@AdarshRawat1 Thanks for your work! This looks great at a glance, especially with your demo. Need a bit more time to dive into the details, but I have a high level comment on the _posts/ directory for now.

My current feeling is that no all existing docs have to become a blog post. Some of them are fine staying as simple markdowns and directly viewed in the GitHub repo.

So here's my proposal:

1. Ultimately, let's aim to make blog posts for project reports only, not including other docs.
2. With 1 as the goal, I suggest we have the blog posts directly under _posts/ without nested directories. Similar to https://github.com/llvm/llvm-blog-www/tree/main/content/posts.
3. For this PR, how about having a single blog post as a demo (e.g. @AdarshRawat1 your project report)? My main consideration is that we could later ask other previous contributors to send PRs for their project reports, and this would be a good exercise for all of us to familiarize with the workflow, both making the blog post and reviewing it. But since @AdarshRawat1 you have already done all the work (I appreciate that a lot!), this might not be worthwhile. I'll leave this to you to decide.

@AdarshRawat1 @Dscano @fruffy What do you think?

[AdarshRawat1]

Sounds Good! we'll host only reports for now.

Adding to your list @qobilidop ...

I'll draft a page including steps to make it easier for new contributors to follow.

[Dscano]

@AdarshRawat1 Thank you for your latest comments. Unfortunately, I haven’t been able to take a look yet. Ideally, I’ll get back to this after February 3, as we are currently focused on finalizing the P4 Consortium submission for GSoC.

[AdarshRawat1]

@AdarshRawat1 Thank you for your latest comments. Unfortunately, I haven’t been able to take a look yet. Ideally, I’ll get back to this after February 3, as we are currently focused on finalizing the P4 Consortium submission for GSoC.

No worries, All the best to team for submission.

[AdarshRawat1]

I’ll switch to using GitHub Raw Links for all images and diagrams. This is the only way to make sure they show up correctly on both the GitHub preview and the live blog without breaking.
Note: You have to upload/push the image to the repo first, then grab the "Raw" link to paste into your Markdown. I’ve added these steps to the Wiki.

Waiting for your inputs then we can do this in a seperate PR to avoid mess.

[AdarshRawat1]

Blog folder contains files related to chirpy theme only.