carta

카르타

현대적이고 가볍고 강력한 마크 다운 편집자.

문서화 · Github

소개

메모

Carta는 최근 v4 로 업데이트되었으며 수많은 주요 변경 사항이 있습니다.

마이그레이션 안내서를 따라 프로젝트를 업데이트하십시오.

Carta는 가볍고 빠르며 확장 가능한 Svelte Markdown 편집기 및 시청자입니다. 통합, 비고 및 rehype로 구동됩니다. 예제를 확인하여 실제로 확인하십시오. Carta에는 대부분의 편집자와는 달리 Carta에는 코드 편집기가 포함되어 있지 않지만 구문 강조 표시, 바로 가기 등의 텍스트 일뿐 입니다.

특징

• ? Markdown 구문 하이라이트 (Shiki);
• 도구 모음 (확장 가능);
• ⌨️ 키보드 단축키 (확장 가능);
• ? 비고 덕분에 150 개 이상의 플러그인을 지원합니다.
• ? 스크롤 동기화;
• ✅ 접근성 친화적 인;
• SSR 호환;
• ⚗️ Katex 지원 (플러그인);
• ? 슬래시 명령 (플러그인);
• ? 포함 된 검색 (플러그인)이 포함 된 이모티콘 ;
• ✏️ Tikz 지원 (플러그인);
• 첨부 지원 (플러그인);
• ⚓ 제목의 앵커 링크 (플러그인);
• ? 코드 블록 구문 강조 표시 (플러그인).
• 임베드 구성 요소 (플러그인);

패키지

패키지	상태	문서
카르타 -MD		/
플러그인 장전		/플러그인/수학
플러그인 코드		/플러그인/코드
플러그인 에모 지		/플러그인/이모티콘
플러그인 슬래시		/플러그인/슬래시
플러그인 틱		/플러그인/Tikz
플러그인 부착		/플러그인/첨부 파일
플러그인 앵커		/플러그인/앵커
플러그인 구성 요소		/플러그인/구성 요소

커뮤니티 플러그인

플러그인	설명
카르타 플루인-비디오	온라인 비디오를 렌더링합니다
카르타-플루그 린 (Carta-Plugin-Imsize)	특정 크기로 이미지를 렌더링합니다
카르타 플루그 핀-서브 스크립트	렌더링 하위 스크립트 및 슈퍼 스크립트
카르타 플루인-인스-델	<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 사용하려고하면 문제가 발생할 수 있습니다.

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

선적 서류 비치

전체 문서, 예제, 가이드 및 더 많은 확인 웹 사이트.

• 소개
• 예
• 시작하기
• 편집 스타일
• 플러그인 :
  • 수학
  • 암호
  • 이모티콘
  • 삭감
  • Tikz
  • 부착
  • 닻
  • 요소
• API :
  • 유용
  • 핵심
  • 확대

기고 및 개발

모든 기여는 잘 받아 들여집니다. 기능 요청이 있으면 새 문제를 열 수 있습니다.

이 패키지는 PNPM 작업 공간을 사용하므로 PNPM은 모든 것을 다운로드하여 올바르게 정리해야합니다.

커밋

이 저장소는 Commitizen 친화적입니다. 사용을 커밋하려면 :

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

실행 문서

문서를 미리 보려면 :

 cd docs
npm run dev