GitHub - iamgio/quarkdown: 🪐 Markdown with superpowers: from ideas to papers, presentations, websites, books, and knowledge bases.

Quarkdown은 CommonMark 및 GFM을 확장하여 Markdown에 함수를 도입한 Quarkdown Flavor를 기반으로 하는 현대적인 Markdown 기반 조판 시스템입니다. 이 시스템의 핵심 개념은 versatility에 있으며, Turing-complete한 Markdown 확장 기능을 통해 단일 소스에서 인쇄 가능한 책, 대화형 프레젠테이션 등 다양한 형식으로 프로젝트를 원활하게 컴파일하는 것을 목표로 합니다.

핵심 방법론 (Core Methodology)

Quarkdown의 핵심은 Markdown 내에서 Turing-complete한 기능을 제공하는 데 있습니다. 이는 다음과 같은 메커니즘을 통해 구현됩니다.

함수 호출 구문 (Function Call Syntax):

Markdown 문서 내에서 .somefunction {arg1} {arg2} Body argument와 같은 구문을 사용하여 함수를 호출할 수 있습니다. 이는 기존 Markdown의 정적인 특성을 넘어 동적 콘텐츠 생성을 가능하게 합니다.

확장 가능한 표준 라이브러리 (Standard Library):

Quarkdown은 layout builders, I/O, math, conditional statements, loops 등을 포함하는 광범위한 표준 라이브러리를 제공합니다. 이를 통해 사용자는 복잡한 문서 구조, 데이터 처리, 조건부 렌더링, 반복적인 콘텐츠 생성을 Markdown 내에서 직접 수행할 수 있습니다.

사용자 정의 함수 및 변수 (User-defined Functions and Variables):

사용자는 Markdown 파일 내에서 직접 자신만의 함수와 변수를 정의할 수 있습니다. 예를 들어, .function {greet} to from: **Hello, .to** from .from!와 같이 함수를 정의하고, .greet {world} from:{iamgio}와 같이 호출하여 동적으로 "Hello, world from iamgio!"와 같은 결과를 얻을 수 있습니다. 이러한 기능은 scripting 능력을 부여하여 vanilla Markdown으로는 불가능한 복잡하고 동적인 콘텐츠를 생성할 수 있도록 합니다.

주요 특징 및 기능 (Key Features and Capabilities)

* 다목적 출력 (Versatile Targets): Quarkdown은 다양한 출력 형식을 지원합니다.
* HTML Plain: 정적 웹사이트 및 지식 관리(예: Notion/Obsidian 스타일)에 적합한 연속적인 흐름을 가진 문서.
* Paged via paged.js: paged.js를 활용하여 인쇄용 서적, 논문, 기사에 최적화된 페이지 기반 문서.
* Slides via reveal.js: reveal.js를 사용하여 대화형 프레젠테이션.
* PDF: 모든 HTML 문서 유형 및 기능이 PDF 내보내기에서 지원됩니다.
문서 유형은 소스 내에서 .doctype {plain}, .doctype {paged}, .doctype {slides} 함수 호출을 통해 설정할 수 있습니다.
* 개발자 경험 (Developer Experience): live preview, 빠른 컴파일 속도(⚡ fast compilation speed), 강력한 VS Code extension을 제공하여 학술 논문, 서적, 지식 기반 또는 대화형 프레젠테이션 작업에 효율적입니다.
* 간결하고 가독성 (Concise and Readable): LaTeX와 비교했을 때, 복잡한 문서 구조(예: 목록, 이미지 배열)를 Markdown의 간결한 구문과 Quarkdown의 함수를 통해 더욱 직관적으로 표현할 수 있습니다. 예를 들어, LaTeX의 \begin{center} This text is \textit{centered}. \end{center}는 Quarkdown에서 .center This text is _centered_ .로 표현됩니다.

설치 및 사용법 (Installation and Usage)

* 설치: Linux/macOS에서는 curl 스크립트나 Homebrew를 통해 설치할 수 있으며, Windows에서는 Scoop을 통해 설치할 수 있습니다. GitHub Actions 통합을 위한 setup-quarkdown도 제공됩니다. Java 17+, Node.js, npm, Puppeteer가 필요합니다.
* 프로젝트 생성: quarkdown create [directory] 명령어를 통해 프롬프트 기반의 프로젝트 마법사를 사용하여 새 Quarkdown 프로젝트를 빠르게 설정할 수 있습니다.
* 컴파일: quarkdown c file.qd 명령어로 소스 파일을 컴파일하며, -p 또는 --preview 옵션으로 실시간 미리보기를 활성화하고, -w 또는 --watch 옵션으로 소스 변경 시 자동 재컴파일을 할 수 있습니다. -p -w 조합으로 live preview를 구현합니다. --pdf 옵션으로 PDF 파일을 생성할 수 있습니다.

라이선스 (License)

기본적으로 Quarkdown과 그 모듈은 GNU GPLv3 라이선스를 따르지만, quarkdown-cli 및 quarkdown-lsp 모듈과 바이너리는 GNU AGPLv3 라이선스를 따릅니다.