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