Skip to content

Convert website source from static HTML to Jekyll-powered Markdown#9

Merged
shenxianpeng merged 3 commits intomainfrom
copilot/convert-html-to-markdown
Mar 24, 2026
Merged

Convert website source from static HTML to Jekyll-powered Markdown#9
shenxianpeng merged 3 commits intomainfrom
copilot/convert-html-to-markdown

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 24, 2026

Website pages were authored as raw HTML files committed directly to the repo. They should be Markdown source files that Jekyll compiles to HTML at publish time.

Changes

Jekyll setup

  • website/_config.yml — enabled Jekyll (was explicitly disabled)
  • website/Gemfile — adds jekyll ~> 4.3
  • website/_layouts/home.html — layout for landing pages; Liquid-driven language switch (page.lang), nav, footer, and CSS
  • website/_layouts/doc.html — layout for doc pages; sidebar with conditional EN/ZH labels, per-page nav links and active-state via front matter

Content: HTML → Markdown (8 files)

  • website/index.md + website/zh/index.md
  • website/docs/{getting-started,how-it-works,local-testing}.md
  • website/zh/docs/{getting-started,how-it-works,local-testing}.md

Standard prose/headings/lists use native Markdown; styled components (step-boxes, callouts, syntax-highlighted code blocks) stay as raw HTML blocks since they rely on custom CSS classes.

All 8 original .html source files removed.

CI: .github/workflows/pages.yaml

Before: uploaded website/ directory directly to Pages.
After: runs bundle exec jekyll build first, uploads _site/ (compiled output).

- uses: ruby/setup-ruby@v1
  with:
    ruby-version: '3.3'
    bundler-cache: true
    working-directory: website

- name: Build with Jekyll
  run: bundle exec jekyll build --destination ../_site
  working-directory: website

- uses: actions/upload-pages-artifact@v4
  with:
    path: _site/

_site/ added to .gitignore.

Original prompt

So, right now, the document was created as HTML. Actually, it should be a Markdown file, and then when you build it and publish it, it converts to HTML.

Please:

  1. Make the document as a Markdown file
  2. Remove all the HTML files from the repository

And when you publish it to the GH Pages branch, it should be the HTML file.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits March 24, 2026 15:11
- Create _layouts/home.html and _layouts/doc.html with full CSS and nav
- Convert all 8 HTML files to Markdown with Jekyll front matter
- Use page.lang, page.section, page.nav_links, page.active_sidebar etc.
  for layout customisation via Liquid templates
- Update website/_config.yml to enable Jekyll
- Add website/Gemfile with jekyll ~> 4.3
- Update .github/workflows/pages.yaml to build with Jekyll before upload
- Add _site/ to .gitignore

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com>
Agent-Logs-Url: https://github.com/castops/cast-slice/sessions/81efc6f4-d874-4e5e-ac46-2bc9a343d540
Copilot AI changed the title [WIP] Convert document to Markdown format and remove HTML files Convert website source from static HTML to Jekyll-powered Markdown Mar 24, 2026
Copilot AI requested a review from shenxianpeng March 24, 2026 15:17
@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Mar 24, 2026
@shenxianpeng shenxianpeng marked this pull request as ready for review March 24, 2026 16:57
@shenxianpeng shenxianpeng merged commit 89d36cb into main Mar 24, 2026
1 check passed
@shenxianpeng shenxianpeng deleted the copilot/convert-html-to-markdown branch March 24, 2026 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants