Skip to content

feat: Markdown to HTML rendering#36

Draft
validcube wants to merge 60 commits intoLawnchairLauncher:masterfrom
validcube:bubbletea-milestone
Draft

feat: Markdown to HTML rendering#36
validcube wants to merge 60 commits intoLawnchairLauncher:masterfrom
validcube:bubbletea-milestone

Conversation

@validcube
Copy link
Copy Markdown
Member

@validcube validcube commented Jan 31, 2026

Instead of editing HTML manually, we can write markdown file instead!

fix #35

Support for extended components like:

  • Frontmatter (title, description, author info, last modified, first published)
  • Inlined Table of Contents (for FAQ)
  • Admonition

Important

Admonition like this! Hi!

The script is partly AI for trivial parts or for cleaning up incomprehensible code I made during 2 AM (as of writing).

@vercel
Copy link
Copy Markdown

vercel Bot commented Jan 31, 2026

@validcube is attempting to deploy a commit to the Lawnchair Team Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request introduces a markdown-to-HTML rendering system for the Lawnchair website, replacing manual HTML editing with markdown files that can be rendered either client-side or pre-rendered during build time for better performance.

Changes:

  • Added build script (scripts/build.js) to pre-render markdown to HTML
  • Added client-side markdown renderer (assets/markdown.js) for dynamic rendering
  • Introduced custom markdown features: metadata (author info, dates), inline ToC, and GitHub-flavored admonitions
  • Converted existing blog posts and FAQ from static HTML to markdown format
  • Added author metadata system (data/authors.json)
  • Updated deployment workflow to include build step
  • Added CSS styling for new markdown components (author cards, admonitions, metadata)

Reviewed changes

Copilot reviewed 18 out of 20 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
scripts/build.js Node.js build script that pre-renders markdown to static HTML, processes metadata, and handles admonitions/ToC
assets/markdown.js Client-side JavaScript for dynamic markdown rendering with same features as build script
package.json & package-lock.json Added dependencies for jsdom (27.0.0) and marked (17.0.1) markdown parser
faq/index.html Converted to use markdown rendering with data-md attribute pointing to faq.md
faq/faq.md New markdown version of FAQ content with metadata support
faq/script.js Updated ToC script to work with both static and dynamically rendered content
blog/*/index.html Updated blog post HTML files to use markdown rendering
blog/*/index.md New markdown source files for blog posts with author metadata
data/authors.json Author information database for rendering author cards
assets/document.css Added CSS for metadata display, author cards, and markdown alerts
.github/workflows/deploy_website.yml Updated to run build script before deployment
.github/README.md Documentation for static site generation and custom markdown components
.gitignore Added node_modules and dist directories

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/README.md Outdated
Comment thread .github/README.md Outdated
Comment thread faq/index.html
Comment thread faq/index.html Outdated
Comment thread .github/README.md Outdated
Comment thread .github/README.md Outdated
Comment thread faq/script.js Outdated
Comment thread assets/markdown.js Outdated
Comment thread blog/lawnstate-2025-reflection/index.md
@vercel
Copy link
Copy Markdown

vercel Bot commented Feb 1, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
lawnchair-app Ready Ready Preview, Comment Apr 12, 2026 2:21am

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 35 out of 38 changed files in this pull request and generated 6 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/CONTRIBUTING.md Outdated
Comment thread blog/lawnchair-14/index.md
Comment thread blog/lawnstate-building-momentum/index.md
Comment thread .github/workflows/deploy_website.yml
Comment thread sitemap.xml Outdated
Comment thread scripts/build.js Outdated
@SuperDragonXD SuperDragonXD marked this pull request as draft April 10, 2026 03:49
# Conflicts:
#	.gitignore
#	blog/index.html
#	blog/lawnchair-14/index.html
#	blog/lawnchair-15-beta-1/index.html
#	blog/lawnstate-2025-reflection/index.html
#	blog/lawnstate-building-momentum/index.html
#	downloads/index.html
#	faq/index.html
#	index.html
#	privacy-policy/index.html
#	support/index.html
@validcube validcube requested a review from Copilot April 11, 2026 18:36
@validcube validcube marked this pull request as ready for review April 11, 2026 18:36
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 36 out of 39 changed files in this pull request and generated 4 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread scripts/build.js
Comment thread scripts/build.js
Comment thread scripts/lib/markdown.js
Comment thread .github/CONTRIBUTING.md Outdated
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 37 out of 40 changed files in this pull request and generated 4 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread blog/index.html Outdated
Comment thread scripts/lib/markdown.js
Comment thread faq/script.js Outdated
Comment thread faq/faq.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: Use a much better documentation/blog system

2 participants