carta

Carta

Éditeur Markdown moderne, léger et puissant.

Documentation · GitHub

Introduction

Note

Carta a récemment été mise à jour vers v4 , qui comporte de nombreux changements majeurs.

Suivez le guide de migration pour mettre à jour votre projet.

Carta est un éditeur et un spectateur de Markdown léger , rapide et extensible . Il est propulsé par Unified, Remark et Rehype. Découvrez les exemples pour le voir en action. Différemment de la plupart des éditeurs, CARTA n'inclut pas un éditeur de code, mais c'est juste une TextArea avec une mise en évidence de syntaxe, des raccourcis et plus encore.

Caractéristiques

• ? Syntaxe de Markdown Highlighting (Shiki);
• Barre d'outils (extensible);
• ⌨️ Raccourcis clavier (extensible);
• ? Prend en charge plus de 150 plugins grâce à Remark;
• ? Scroll Sync;
• ✅ convivial sur l'accessibilité;
• SSR compatible;
• ⚗️ Prise en charge de Katex (plugin);
• ? Commandes de slash (plugin);
• ? Emojis , avec recherche incluse (plugin);
• ✏️ Prise en charge TIKZ (plugin);
• Prise en charge de la pièce jointe (plugin);
• ⚓ Liens d'ancrage dans les en-têtes (plugin);
• ? Code Blocks Syntaxe Syntax Imposition (plugin).
• Composants intégrés (plugin);

Packages

Emballer	Statut	Docs
carta-md		/ /
plugin-math		/ Plugins / mathématiques
code de plugin		/ plugins / code
plugin-emoji		/ plugins / emoji
plugin-slash		/ Plugins / Slash
plugin-tikz		/ plugins / tikz
attachement du plugin		/ plugins / pièce jointe
anculaire		/ plugins / ancre
plugin-composant		/ Plugins / Composant

Plugins communautaires

Plugin	Description
carta-plugin-video	Rendre des vidéos en ligne
Carta-Plugin-iMsize	Rendre des images dans des tailles spécifiques
carta-plugin-subscrit	Rendez les indices et les exposés
carta-plugin-ins-del	Soutien des balises <ins> et <del>

Commencer

Avertissement

La désinfection n'est pas traitée par Carta. Vous devez fournir un sanitizer dans les options. Les désinfectants communs sont des dompurifiens isomorphes (suggérés) et désinfecter-HTML. Découvrez la documentation pour un exemple.

Installation

Package de base:

 npm i carta-md

Plugins:

 npm i @cartamd/plugin-name

Configuration de base

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

Drapeaux

Vous pouvez réduire le bundle côté serveur en utilisant la configuration VITE suivante. Cela supprimera Shiki du paquet. Cela peut entraîner des problèmes si vous essayez d'utiliser plugin-code sur le serveur, car le surligneur n'y est plus présent.

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

Documentation

Pour la documentation complète, des exemples, des guides et plus de contrôle sur le site Web.

• Introduction
• Exemples
• Commencer
• Styles d'édition
• Plugins:
  • Mathématiques
  • Code
  • Emoji
  • Sabrer
  • Tikz
  • Pièce jointe
  • Ancre
  • Composant
• API:
  • Services publics
  • Cœur
  • Extension

Contribution et développement

Chaque contribution est bien acceptée. Si vous avez une demande de fonctionnalité, vous pouvez ouvrir un nouveau problème.

Ce package utilise un espace de travail PNPM, donc PNPM est nécessaire pour télécharger et tout assembler correctement.

Engagement

Ce référentiel est adapté aux engagements. Pour commettre une utilisation:

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

Running Docs

Si vous souhaitez prévisualiser les documents:

 cd docs
npm run dev