carta

Хартинг

Современный, легкий, мощный редактор разметки.

Документация · Github

Введение

Примечание

Carta недавно была обновлена до v4 , которая включает в себя многочисленные серьезные изменения.

Следуйте руководству по миграции, чтобы обновить свой проект.

Carta - это легкий , быстрый и расширяемый редактор и зритель. Он основан на Unified, замечании и Rehype. Проверьте примеры, чтобы увидеть это в действии. В отличие от большинства редакторов, Carta не включает редактор кода, но это всего лишь текстовое значение с синтаксисом, ярлыками и многое другое.

Функции

• ? Основное количество синтаксиса Markdown (Shiki);
• Панель инструментов (расширяемая);
• ⌨ сочетания клавиш (расширяемый);
• ? Поддерживает более 150 плагинов благодаря замечанию;
• ? Синхронизация прокрутки;
• ✅ Доступ к доступности;
• SSR совместимо;
• ⚗ поддержка Katex (плагин);
• ? Команды SLASH (плагин);
• ? Эмодзи , с включенным поиском (плагин);
• ✏ Поддержка тикза (плагин);
• Поддержка вложения (плагин);
• ⚓ Привязки ссылок в заголовках (плагин);
• ? Синтаксис кодового синтаксиса (плагин).
• Встроенные компоненты (плагин);

Пакеты

Упаковка	Статус	Док
харт-мд		/
плагин-мат		/плагины/математика
плагин-код		/плагины/код
плагин-эмоджи		/плагины/смайлики
плагин		/плагины/Слэш
плагин-тикз		/плагины/тик
плагин-привязанность		/плагины/вложение
плагин-ангор		/плагины/якорь
плагин-компонент		/плагины/компонент

Общественные плагины

Плагин	Описание
Чард-плугин-видео	Рендеринг онлайн видео
Карто-плугин-Imsize	Рендеринг изображения в определенных размерах
Картия-плугин-Subscript	Рендеринг подписки и суперкрипты
Чард-плугин-дюйма-дель	<ins> и <del> Поддержка тегов

Начиная

Предупреждение

Дезинфицирование не рассматривается хартией. Вы должны предоставить 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. Это удалит Шики из пакета. Это может вызвать проблемы, если вы попытаетесь использовать plugin-code на сервере, так как Highlider больше не присутствует.

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