Skip to content

share-man-man/scribdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

131 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Scribdown

Scribdown 提供统一的 Markdown 渲染体验,可同时作为浏览器插件与 VS Code 插件运行,复用同一套渲染核心与视觉组件。

  • 多端一致:浏览器插件与 VS Code 插件共用渲染核心与视觉组件。
  • 安全默认:原始 HTML 经 rehype-sanitize + DOMPurify 双层清洗。

技术栈:TypeScript · React · remark/rehype · shikipnpm workspace + Turborepo 管理的 Monorepo。

快速上手

pnpm install   # 安装依赖(Node 24.15.0 / pnpm 10.33.0,见 .tool-versions)
pnpm dev       # 并行启动所有 apps dev

更完整的环境要求与上手步骤见文档站「快速上手」。

仓库结构

apps/        浏览器插件、VS Code 插件、文档站、渲染预览沙盒
packages/    markdown-renderer(渲染核心)、ui-handdrawn(视觉组件)、shared(常量枚举)

详细的包依赖与模块职责见文档站「架构设计」。

文档

类型 入口 说明
文档站 apps/docs 产品介绍、快速上手、设计体系与开发文档(VitePress,pnpm --filter @scribdown/docs dev
设计资产 design/README.md Pencil 源文件、导出图与设计资产说明
开发 Wiki wiki/Home.md 架构、模块、发布流程等内部文档

About

Render markdown like scribble ✍️

Topics

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Contributors