marktion

中文/영어

마케팅 소개

Marktion은 Prosemirror를 기반으로하는 Wysiwyg Markdown 편집기로 Markdown의 편집 경험을 향상시키기 위해 전용입니다.

우리의 웹 사이트 Marktion.io를 참조하십시오.

특징

• [New] AI 통합 : AI 플러그인 확장을 지원하는 내장 AI 대화 인터페이스, 공간을 누르면 라인의 시작 부분에서 호출;

• Wysiwyg 편집 : 마크 다운 렌더링 결과의 실시간 미리보기, 직관적 편집 경험을 제공하며 소스 코드 모드와 Wysiwyg 편집 모드를 Ctrl + /로 전환 할 수 있습니다.

• 슬래시 메뉴 및 버블 메뉴 : /를 사용하는 개념 편집기에서 빠르게 영감을 얻었습니다. 다크 모드 지원 : Dark Mode를 켜거나 끄는 지원.

• 다크 모드 지원 : 어두운 모드를 사용하여 저조도 환경에서 시각적으로 편집 된 편집 경험을 제공합니다.

설치 및 사용

1. 종속성을 설치하십시오.

npm intall marktion

2. 용법

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

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

3. 예

Marktion.io를 실제로 볼 수 있도록 예제를 살펴보십시오.

API

ReacteditorProps

재산	설명	유형	기본
콘텐츠	편집기의 초기 마크 다운 컨텐츠.	끈	-
어두운	편집기에서 Dark Mode를 활성화 또는 비활성화합니다.	부울	거짓
uploadoptions.uploader	이미지 업로드를위한 콜백 기능.	(file: File, event: ClipboardEvent | InputEvent, view: ProsemirrorView) => Promise<url>	-
세우다	렌더러 모드	WYSIWYG | SOURCE
onchange	편집기 컨텐츠 변경 콜백	(editor: Marktion) => void

더 많은 API를 찾으려면 Tiptap의 문서를 참조하십시오.

마케팅 레프

재산	설명	유형	기본
편집자	마케팅 인스턴스	마케팅	-

예제 사용 :

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

플러그인

AI 플러그인

AI 플러그인은 Vercel AI를 기반으로합니다. 시작하기 전에 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]

• 문제 추적기 : 프로젝트 문제 (문제 제목에서 문제 유형을 지정하십시오)