marktion

中文/английский

Введение значения

Партия является редактором Wysiwyg Markdown, основанного на Prosemirror, посвященном улучшению опыта редактирования Markdown.

Смотрите наш веб -сайт.

Функции

• [Новая] ИИ интеграция : встроенный интерфейс разговора с искусственным интеллектом, поддержка расширений плагинов искусственного интеллекта, вызванный в начале линии, нажав на пространство;

• Редактирование Wysiwyg : предварительный просмотр результатов рендеринга маркировки в реальном времени, обеспечивая интуитивно понятный опыт редактирования, и вы можете переключаться между режимом исходного кода и режимом редактирования Wysiwyg с CTRL + /;

• Меню Slash и Bubble Menu : быстро вдохновляется редактором понятия, используя /; Поддержка темного режима: поддержка включения или выключения темного режима.

• Поддержка темного режима : включите Dark Mode, чтобы обеспечить визуально удобное редактирование в условиях низкого освещения.

Установка и использование

1. Установить зависимости.

npm intall marktion

2. Использование

 import { ReactEditor } from 'marktion' ;
import 'marktion/dist/style.css' ;

function Editor ( ) {
  return < ReactEditor content = { `# Hello World` } /> ;
}

3. Пример

Посмотрите на примеры, чтобы увидеть значение .IO в действии.

API

ReacteditorProps

Свойство	Описание	Тип	По умолчанию
содержание	Первоначальный контент разметки для редактора.	нить	-
темный	Включить или отключить темный режим в редакторе.	логический	ЛОЖЬ
uploadoptions.uploader	Функция обратного вызова для загрузки изображений.	(file: File, event: ClipboardEvent | InputEvent, view: ProsemirrorView) => Promise<url>	-
оказывать	Режим рендерера	WYSIWYG | SOURCE
Онхандж	Обратный вызов изменения контента редактора	(editor: Marktion) => void

Проконсультируйтесь с документацией Tiptap, чтобы найти больше API.

JARKTICEREF

Свойство	Описание	Тип	По умолчанию
редактор	отмечать экземпляр	Знак	-

Пример использования:

 import { ReactEditor , ReactEditorRef } from 'marktion' ;

function App ( ) {
  const editorRef = useRef < ReactEditorRef > ( null ) ;

  const onExport = ( ) => {
    const content = editorRef . current ?. editor . getContent ( ) ;
    console . log ( content ) ;
  } ;

  return (
    < >
      < button onClick = { onExport } > export </ button >
      < ReactEditor ref = { editorRef } />
    </ >
  ) ;
} 

Плагины

Плагин ИИ

Плагин ИИ основан на Vercel AI. Прежде чем начать, вам нужно создать маршрутизатор ИИ. Пожалуйста, обратитесь к документации для получения дополнительной информации: Начало работы.

Пример использования:

 function Editor ( ) {
  const ai = useAI ( {
    basePath : import . meta . env . VITE_OPENAI_BASE_URL
  } ) ;

  return (
    < ReactEditor ref = { editorRef } plugins = { [ ai . plugin ] } >
      { ai . element }
    </ ReactEditor / >
  )
} 

Внося

Спасибо за рассмотрение внесения значений! Если вы хотите внести свой вклад, пожалуйста, следуйте этим шагам:

1. Разветвляется репозиторий в свою учетную запись GitHub.

2. Клонировать раздвоенный репозиторий в местную машину.

git clone https://github.com/yourusername/marktion.git
cd marktion

3. Установить зависимости.

pnpm i

4. Внесите изменения и проверьте свои модификации.

5. Совершить свои изменения.

6. Создайте запрос на тягу.

Перейдите к исходному репозиторию и нажмите «Новый запрос на развлечение». Заполните необходимые детали и опишите внесенные вами изменения.

Мы рассмотрим ваш запрос на привлечение как можно скорее. Спасибо за ваш вклад!

Лицензия

Этот проект лицензирован по лицензии MIT. Смотрите файл лицензии для получения более подробной информации.

Контакт

Если у вас есть какие -либо вопросы, предложения или проблемы, не стесняйтесь обращаться к нам по следующим каналам:

• Электронная почта: [email protected]

• Трекер проблемы: проблемы проекта (укажите тип выпуска в названии выпуска)