Welcome to the JadeView Blog 🌱
Welcome to the JadeView Blog — a fully open-source blog maintained by the community. Every post is simply a Markdown file living in the docs/blog/ directory of the documentation repo. We accept contributions through GitHub Pull Requests (PR): once your PR is merged, the post automatically appears in the blog sidebar — no manual publishing needed.
We look forward to posts like these:
Development experience: lessons and tips for building WebView desktop apps with JadeView;
Ecosystem sharing: how-to guides for the SDKs (Web / Python / E-Language / VolDP / Golang) and tools (JadePack / Jade EC);
Example projects: open-source demos and practical, runnable code;
Community topics: front-end / desktop-dev news and opinions (must be original or licensed).
How to contribute (three steps)
1. Prepare a Markdown file
In the JadeViewDocs/docs repo, create a new Markdown file under docs/blog/, using a kebab-case English filename (e.g. my-first-post.md). Every file must start with frontmatter — here is the template:
---
title: Your Post Title
description: One-line summary (used for search & SEO, aim for 1–2 sentences)
tags: [tag1, tag2] # optional, 1–3 tags
---
The post header automatically shows the author (avatar + nickname), publish
date and "Edit this page" — all generated by the CI workflow from Git history:
the avatar, nickname and GitHub profile link come from the PR author's GitHub
account, and the publish date comes from the file's first commit. No fields
to fill in.
# Title
Body content… standard Markdown is supported.Tip: if you provide English and Chinese, add a matching
xxx.en-US.md— both are accepted.
2. Open a PR
- Click Fork in the top-right corner to copy the repo to your account;
- In your fork, create a branch and commit the Markdown file (and any image assets) to it;
- Back on the original
JadeViewDocs/docsrepo, click New Pull Request; - Pick your branch, title the PR with the post's topic, and describe the changes in the description;
- Create the PR and wait for review — it is published once merged.
3. Wait for the merge
We review as soon as we can. If the post needs adjustments, we'll note them in the PR comments; update and resubmit.
How to insert images? Rules below
Core principle: don't use local relative paths inside markdown — put images in the public asset directory and reference them by site-absolute paths.
Where to store: under
public/blog/<your-slug>/in the repo root, create a folder for your post and keep all its images there to avoid conflicts.How to reference: use standard image syntax and always include alt text (good for accessibility and SEO):
MarkdownNote: a path starting with
/blog/maps to thepublic/blog/directory.Format & size: prefer PNG / JPEG / WebP, and keep each image under 1MB; compress wide images locally before uploading.
Forbidden: no hot-linked external images (they can't be reviewed and break easily); no unauthorized images.
Contribution rules (please follow)
These rules are enforced during review and merge to keep content high-quality and compliant:
Original or licensed: posts must be your own work or used with the original author / rights-holder's permission; no plagiarism or republishing without consent.
Compliant content: no illegal, infringing, malicious-ad, or harassing content; obtain permission when third parties are involved.
Image standards: follow the "Image rules" above; no hot-links, no unauthorized images.
Technically accurate: sample code and conclusions should be real and runnable, and must not mislead readers.
Clean formatting: follow the frontmatter template; keep titles and filenames consistent; submit
xxx.md+xxx.en-US.mdas a pair for bilingual posts.Review authority: the maintenance team reserves the right to edit or reject content, structure, or naming.
Thank you for sharing your experience and making the JadeView ecosystem richer. We look forward to your first post 🚀