carta

Carta

Moderno, ligero y potente editor de Markdown.

Documentación · Github

Introducción

Nota

La Carta se ha actualizado recientemente a v4 , que presenta numerosos cambios importantes.

Siga la guía de migración para actualizar su proyecto.

La Carta es un editor y espectador liviano , rápido y extensible de Svelte Markdown. Está impulsado por unificado, observación y rehipo. Echa un vistazo a los ejemplos para verlo en acción. De manera diferente a la mayoría de los editores, la Carta no incluye un editor de código, pero es solo un textea con resaltado de sintaxis, atajos y más.

Características

• ? Resaltado de sintaxis de Markdown (shiki);
• Barra de herramientas (extensible);
• ⌨️ TeckCuts de teclado (extensible);
• ? Admite más de 150 complementos gracias a la observación;
• ? Sincronización de desplazamiento;
• ✅ Accesibilidad amigable;
• SSR compatible;
• ⚗️ Katex Support (complemento);
• ? Comandos de corte (complemento);
• ? Emojis , con búsqueda incluida (complemento);
• ✏️ Tikz Support (complemento);
• Soporte de archivos adjuntos (complemento);
• ⚓ Enlaces de anclaje en encabezados (complemento);
• ? Código bloquea la resaltura de sintaxis (complemento).
• Incrustar componentes (complemento);

Paquetes

Paquete	Estado	Documento
Carta-MD		/
mate de complemento		/complementos/matemáticas
código de complemento		/complementos/código
complemento-emoji		/complementos/emoji
pliegue		/Plugins/Slash
plugin-tikz		/complementos/tikz
atacamiento del complemento		/complementos/adjunto
enchufador		/Plugins/Anchor
componente de complemento		/complementos/componente

Complementos comunitarios

Complemento	Descripción
video de carta-plugin	Renderizar videos en línea
CARTAPLUGIN-IMSIZA	Renderizar imágenes en tamaños específicos
Cart-plugin-subscript	Renderizar subíndices y superíndices
CARTAPLUGIN-IN-DEL	<ins> y <del> Soporte de etiquetas

Empezando

Advertencia

La desinfección no es tratada por Carta. Debe proporcionar un sanitizer en las opciones. Los desinfectantes comunes son isomórficos-dompurify (sugeridos) y desinfectan HTML. Consulte la documentación para obtener un ejemplo.

Instalación

Paquete central:

 npm i carta-md

Complementos:

 npm i @cartamd/plugin-name

Configuración básica

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

Banderas

Puede reducir el paquete del lado del servidor utilizando la siguiente configuración VITE. Esto eliminará a Shiki del paquete. Puede causar problemas si intenta usar plugin-code en el servidor, ya que el marcador ya no está presente allí.

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

Documentación

Para la documentación completa, ejemplos, guías y más consulta el sitio web.

• Introducción
• Ejemplos
• Empezando
• Estilos de edición
• Complementos:
  • Matemáticas
  • Código
  • Emoji
  • Barra oblicua
  • Tikz
  • Adjunto
  • Ancla
  • Componente
• API:
  • Utilidades
  • Centro
  • Extensión

Contribuyente y desarrollo

Cada contribución es bien aceptada. Si tiene una solicitud de función, puede abrir un nuevo problema.

Este paquete utiliza un espacio de trabajo PNPM, por lo que se requiere PNPM para descargar y armar todo correctamente.

Comprometido

Este repositorio es amigable con el comité. Para comprometer el uso:

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

Correr documentos

Si desea obtener una vista previa de los documentos:

 cd docs
npm run dev