carta

卡塔

现代，轻巧，有力的降价编辑器。

文档· github

介绍

笔记

Carta最近已更新为v4 ，该V4具有许多重大变化。

遵循迁移指南以更新您的项目。

Carta是一款轻巧，快速且可扩展的Svelte Markdown编辑器和观众。它由统一，备注和重新构想。查看示例以查看它的作用。与大多数编辑者不同，CARTA不包括代码编辑器，但它只是一个带有语法突出显示，快捷方式等的文本主题。

特征

• ？ MARKDOWN语法突出显示（Shiki）;
• 工具栏（可扩展）;
• ⌨️键盘快捷键（可扩展）;
• ？多亏了备注，支持150多个插件；
• ？滚动同步；
• ✅可访问性友好；
• SSR兼容；
• ⚗️katex支持（插件）;
• ？ Slash命令（插件）;
• ？表情符号，包含搜索（插件）；
• ✏️tikz支持（插件）;
• 附件支持（插件）；
• ⚓标题中的锚定链接（插件）；
• ？代码块语法突出显示（插件）。
• 嵌入组件（插件）;

软件包

包裹	地位	文档
Carta-Md		/
插件成员		/插件/数学
插件代码		/插件/代码
插件 - emoji		/插件/表情符号
插件斜线		/插件/斜杠
插件tikz		/插件/tikz
插件连接		/插件/附件
插件锚		/插件/锚
插件组件		/插件/组件

社区插件

插件	描述
Carta-Plugin-Video	渲染在线视频
Carta-Plugin-Imsize	渲染特定尺寸的图像
Carta-Plugin-Subscript	渲染下标和上标
Carta-Plugin-ins-Del	<ins>和<del>标签支持

入门

警告

Carta无法处理消毒。您需要在选项中提供sanitizer 。常见的消毒剂是同构兼容（建议）和消毒-HTML。查看示例的文档。

安装

核心包：

 npm i carta-md

插件：

 npm i @cartamd/plugin-name

基本配置

< script lang = " ts " >
	import { Carta , MarkdownEditor } from ' carta-md ' ;
	// Component default theme
	import ' carta-md/default.css ' ;

	const carta = new Carta ({
		// Remember to use a sanitizer to prevent XSS attacks
		// sanitizer: mySanitizer
	});
</ script >

< MarkdownEditor { carta } />

< style >
	/* Or in global stylesheet */
	/* Set your monospace font (Required to have the editor working correctly!) */
	:global( .carta-font-code ) {
		font-family : ' ... ' , monospace ;
		font-size : 1.1 rem ;
	}
</ style >

标志

您可以使用以下VITE配置来减少服务器端捆绑包。这将从捆绑包中删除shiki。如果您尝试使用服务器上的plugin-code ，可能会导致问题，因为荧光笔不再存在。

 // vite.config.js
import { sveltekit } from '@sveltejs/kit/vite' ;

/** @type {import('vite').UserConfig} */
const config = {
	plugins : [ sveltekit ( ) ] ,
	define : {
		__ENABLE_CARTA_SSR_HIGHLIGHTER__ : false
	}
} ;
export default config ;

文档

有关完整的文档，示例，指南和更多结帐网站。

• 介绍
• 例子
• 入门
• 编辑样式
• 插件：
  • 数学
  • 代码
  • 表情符号
  • 削减
  • 蒂克兹
  • 依恋
  • 锚
  • 成分
• API：
  • 公用事业
  • 核
  • 扩大

贡献与发展

每个贡献都被公认。如果您有功能请求，则可以打开新问题。

该软件包使用PNPM工作区，因此需要PNPM才能正确下载并将所有内容放在一起。

投入

这个存储库是友好的。提交使用：

 npm run commit
# or, if you have commitizen installed globally
git cz

运行文档

如果您想预览文档：

 cd docs
npm run dev