<img src="https://github.com/2061360308/InkStone-Markdown/raw/0.3.2/public/cover.png" alt='砚台封面' style="background-color: white;"/>



<img src="https://img.shields.io/badge/vue-3.x-brightgreen.svg" alt="Vue 3" />
<img src="https://img.shields.io/badge/github-api-blue.svg" alt="GitHub API" />
<img src="https://img.shields.io/badge/typescript-4.x-007ACC.svg" alt="TypeScript" />
<img src="https://img.shields.io/github/stars/2061360308/InkStone.svg?style=social" alt="Stars" />
<img src="https://img.shields.io/github/forks/2061360308/InkStone.svg?style=social" alt="Forks" />
<img src="https://img.shields.io/github/issues/2061360308/InkStone.svg?color=yellow" alt="Issues" />
<img src="https://img.shields.io/badge/license-MIT-green.svg" alt="MIT License" />

相关文档请见官网: https://inkstone.work

砚台/InkStone

💡 介绍

砚台 是一款由 Vue 开发的Markdown编辑器。虽然这是一个很新的项目很多功能仍然有待完善中，但是依赖于Vidtor编辑器和Codemirror编辑器砚台能够提供可靠舒适的Markdown体验以及完成轻量的代码编辑浏览工作。同时依赖于最新的Web标准，砚台在提供不输于原生应用的前提下，本身只是一款纯前端的Web应用，方便部署的同时还能再任意设备平台上使用。

<a href="https://github.com/2061360308/InkStone-Markdown/raw/0.3.2/docs/screenshots.md">@更多截图</a>

体验地址

Vercel

✨ 特性

使用场景

1. 安装Pwa后作为本地Markdown编辑器
2. 作为在线代码编辑器简单编辑Github仓库代码（类似dev.github.com）
3. 在移动设备上安装后充当PC端Markdown编辑器的补充
4. 随个人静态博客一起发布作为博客编辑后端

✅预计开发任务

• [x] 迁移整理图标相关代码
• [x] GitHub 拉取/提交文件策略更新
• [x] 文件管理器优化，外观，功能
• [ ] 主题统一，支持切换
• [x] 允许加载/保存全局配置
• [x] 编辑器添加处理格式字符串的功能
• [x] 事件总线完善
• [x] 更加完整的底部状态条功能
• [x] 提供更多登录方式,注册成为 GitHub App
• [x] 大纲列表
• [x] 搜索列表
• [x] 更完整的设置面板，支持更多可选项配置
• [x] 图床开发
• [x] 适配 history 和 hash 两种模式
• [ ] 自定义 Github 接口代理
• [x] 重构css样式，更换sass语法。添加夜间模式支持
• [x] 重构组件代码，分离混合搅乱的部分
• [x] 添加按需导入，分片打包。优化加载速度
• [ ] 添加更加实用的图床管理功能
• [ ] 添加Wasm本地处理图片的能力
• [x] Pwa优化，向本地编辑器功能看齐
• [x] 完善现有的Codemirror编辑器功能
• [x] 修复编辑器全屏Bug
• [ ] Front Matter 可视化编辑改为可选
• [ ] 修复个人Token登录流程

如有新的需求或者急需上述某个功能可在 issue 中提出

获取进阶能力

砚台 是一款渐进式网页应用，你可以通过安装得到如下更加舒适的体验： 1. 趋于原生的标题栏 2. 设置为系统打开Markdown文件的默认应用 3. 完全离线使用（数据将会被缓存，断网可用）

🛠️ 开发/自部署

砚台 是一个完全的前端应用程序不含有任何后端内容，部署它的要求非常低。如果你有服务器直接复制打包内容到服务器上即可且仅需要8Mb的存储空间。如果没有也没有关系Github Pages、COS、Vercel等平台均可部署 砚台

自行打包运行步骤（Vite项目打包通用步骤）

1. clone项目到本地
2. 使用pnpm install安装依赖
3. pnpm run dev / pnpm build运行或打包

📄 授权

InkStone 使用 MIT 开源协议。

🙏 鸣谢

Vditor：是一款浏览器端的 Markdown 编辑器，支持所见即所得、即时渲染（类似 Typora）和分屏预览模式。它使用 TypeScript 实现，支持原生 JavaScript 以及 Vue、React、Angular 和 Svelte 等框架。

Vue：Vue (pronounced /vjuː/, like view) is a progressive framework for building user interfaces.

Lute：🎼 一款结构化的 Markdown 引擎，支持 Go 和 JavaScript

highlight.js：JavaScript syntax highlighter

mermaid：Generation of diagram and flowchart from text in a similar manner as Markdown

incubator-echarts：A powerful, interactive charting and visualization library for browser

abcjs：JavaScript library for rendering standard music notation in a browser