carta

Karta

Editor Markdown Modern, Ringan, dan Kuat.

Dokumentasi · GitHub

Perkenalan

Catatan

Carta baru -baru ini telah diperbarui ke v4 , yang menampilkan banyak perubahan besar.

Ikuti panduan migrasi untuk memperbarui proyek Anda.

Carta adalah editor dan penonton yang ringan , cepat dan dapat diperluas . Didukung oleh Unified, Comment dan Rehype. Lihat contoh untuk melihatnya beraksi. Berbeda dari kebanyakan editor, Carta tidak termasuk editor kode, tetapi hanya tekstara dengan sintaksis sintaks, pintasan dan banyak lagi.

Fitur

• ? Markdown Sintaks Sorote (Shiki);
• Toolbar (extensible);
• ⌨️ Pintasan keyboard (dapat diperpanjang);
• ? Mendukung 150+ plugin berkat komentar;
• ? Sinkronisasi Gulir;
• ✅ Ramah aksesibilitas;
• Kompatibel SSR ;
• ⚗️ Dukungan Katex (plugin);
• ? Perintah Slash (plugin);
• ? Emoji , dengan pencarian yang disertakan (plugin);
• ✏️ Dukungan Tikz (plugin);
• Dukungan lampiran (plugin);
• ⚓ tautan jangkar di judul (plugin);
• ? Kode Blok Sintaks Sorot (plugin).
• Komponen sematan (plugin);

Paket

Kemasan	Status	Dokumen
CARTA-MD		/
Mate plugin		/plugin/matematika
kode plugin		/plugin/kode
Plugin-Emoji		/plugin/emoji
plugin-slash		/Plugin/Slash
Plugin-Tikz		/plugin/tikz
Plugin-Attachment		/plugin/lampiran
Plugin-Anchor		/plugin/jangkar
Komponen plugin		/plugin/komponen

Plugin komunitas

Plugin	Keterangan
CARTA-PLUGIN-Video	Render video online
CARTA-PLUGIN-IMSIZE	Render gambar dalam ukuran tertentu
CARTA-PLUGIN-Subscript	Render Subscripts dan Superscripts
CARTA-PLUGIN-INS-DEL	<ins> dan <del> tag dukungan tag

Memulai

Peringatan

Sanitasi tidak ditangani oleh Carta. Anda perlu memberikan sanitizer di opsi. Sanitizer umum adalah isomorfik-berkompurifikasi (disarankan) dan membersihkan-HTML. Periksa dokumentasi untuk contoh.

Instalasi

Paket Inti:

 npm i carta-md

Plugin:

 npm i @cartamd/plugin-name

Konfigurasi Dasar

< 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 >

Bendera

Anda dapat mengurangi bundel sisi server dengan menggunakan konfigurasi vite berikut. Ini akan menghapus Shiki dari bundel. Ini dapat menyebabkan masalah jika Anda mencoba menggunakan plugin-code di server, karena stabilo tidak lagi ada di sana.

 // 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 ;

Dokumentasi

Untuk dokumentasi lengkap, contoh, pemandu, dan lebih banyak lagi checkout situs web.

• Perkenalan
• Contoh
• Memulai
• Gaya pengeditan
• Plugin:
  • Matematika
  • Kode
  • Emoji
  • Memotong
  • Tikz
  • Lampiran
  • Jangkar
  • Komponen
• API:
  • Utilitas
  • Inti
  • Perpanjangan

Berkontribusi & pengembangan

Setiap kontribusi diterima dengan baik. Jika Anda memiliki permintaan fitur, Anda dapat membuka masalah baru.

Paket ini menggunakan ruang kerja PNPM, jadi PNPM diperlukan untuk mengunduh dan menyatukan semuanya dengan benar.

Berkomitmen

Repositori ini ramah komitizen. Untuk melakukan penggunaan:

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

Menjalankan dokumen

Jika Anda ingin mempratinjau dokumen:

 cd docs
npm run dev