欢迎来到 JadeView 博客 🌱
欢迎来到 JadeView 博客!这是一个完全基于开源、由社区共同维护的博客:每一篇文章其实就是一份 Markdown 文档,存放于文档站的 docs/blog/ 目录。我们通过 GitHub Pull Request(PR)接受所有投稿——你提交的 PR 被合并后,文章就会自动出现在博客侧边栏的文章列表里,无需人工发布。
我们期待收录这些类型的文章:
开发经验:用 JadeView 构建 WebView 桌面应用的踩坑与心得;
生态分享:SDK(Web / Python / 易语言 / 火山 / Golang)、工具(JadePack / Jade EC)的使用技巧;
示例项目:开源 demo、能落地的实战代码;
社区杂谈:与前端、桌面开发相关的资讯或观点(须原创或已授权)。
如何投稿(三步走)
1. 准备一个 Markdown 文件
在仓库 JadeViewDocs/docs 的 docs/blog/ 目录下新建一个 Markdown 文件,建议用英文短横线命名(例如 my-first-post.md)。文件开头必须带 frontmatter,模板如下:
---
title: 你的文章标题
description: 一句话简介(用于搜索与 SEO,建议 1~2 句)
tags: [标签1, 标签2] # 可选,1~3 个
---
文章顶部会自动展示「投稿人(头像+昵称)」「投稿时间」和「编辑此页」——
全部由 CI 工作流从 Git 提交记录自动生成:头像、昵称与 GitHub 主页链接取自
PR 作者的 GitHub 账号,投稿时间取自文章的首次提交时间,无需填写任何字段。
# 标题
正文内容……支持标准 Markdown 语法。提示:如果遵守中英双语,可另存一份
xxx.en-US.md,两篇都会被收录。
2. 提交 PR
- 点击仓库右上角 Fork,把仓库复制到你自己的账号;
- 在 fork 出来的仓库里新建分支,把 Markdown 文件(及插图等资源)提交到这个分支;
- 回到
JadeViewDocs/docs原仓库,点击 New Pull Request; - 选择你的分支,标题写明这篇博客的主题,描述里简述文章内容与改动;
- 创建 PR 后等待社区评审,合并通过即发布。
3. 耐心等待合并
我们会尽快审阅。若结构不合规范或需要修改,会在 PR 评论里指出,你改了重新提交即可。
图片如何插入?规则如下
核心原则:图片不直接写进 markdown 的本地相对路径,而是放在公开资源目录后使用「站点绝对路径」引用。
存放位置:在仓库根目录
public/blog/<文章slug>/下,为你的文章单独建一个文件夹,所有图片放里面,避免与他人冲突。引用写法:markdown 正文里用标准图片语法,必须写 alt 描述文本(利于无障碍与 SEO):
Markdown注意路径以
/blog/开头 =public/blog/目录。格式与体积建议:建议使用 PNG / JPEG / WebP,单张不超过 1MB;过宽的长图请先在本地压缩再上传。
禁止事项:禁止引用外部热链图片(无法审核、易失效);禁止使用未经授权的图片。
投稿规则(请务必遵守)
为保证内容质量与合规,以下规则在评审与合并时会强制执行:
原创或已授权:文章必须为本人原创,或已获得原作者、版权方授权引用;禁止抄袭、搬运。
合规内容:不包含违法违规、侵权、恶意广告、攻击性言论;涉及第三方的要先征得授权。
图片规范:按上文「图片插入规则」存放与引用;不引用外链热链图、不用未授权图。
技术属实:示例代码与结论应为真实可运行的,避免误导读者。
格式整洁:遵循上面的 frontmatter 模板,标题与文件命名规范;如投稿中英文双语按
xxx.md+xxx.en-US.md成对提交。评审权:维护团队保留对内容、结构、命名进行修改、或拒绝合并的权利。
感谢你愿意分享经验,让 JadeView 生态更丰富。期待你的第一篇投稿 🚀