Zettlr

KO | EN

gitlite — search

#javascript #react #typescript #go #golang #android #deep-learning #linux #macos #windows #kubernetes #vue #mcp #openai

(★ 13,413)

Your One-Stop Publication Workbench

파일 탐색기

최종 버전 다운로드 (.zip)

- - bug_report.yml
  - config.yml
  - enhancement_request.yml
  - feature_request.yml
- - audit.yml
  - build.yml
  - bump-transitive.yml
  - check-pr-description.yml
  - check.yml
  - i18n.yaml
  - lint-po.yml
  - update.yml
- boring-cyborg.yml
- dependabot.yml
- FUNDING.yml
- PULL_REQUEST_TEMPLATE.md
- stale.yml
- extensions.json
- launch.json
- settings.json
- zettlr.code-snippets
- - .gitignore
  - Assets.car
  - compile-macos-icon.sh
  - icon.code.icns
  - icon.develop.xcf
  - icon.icns
  - icon.ico
  - icon.xcf
  - README.md
- - NSISinstallerHeader.bmp
  - NSISinstallerHeader.xcf
  - NSISinstallerSidebar.bmp
  - NSISinstallerSidebar.xcf
- - zettlr_view.png
  - zettlr_view_dark.png
- .gitignore
- - apt-index.htm
  - entitlements.plist
  - info.plist
  - nightly-index.php
  - nightly-sm_preview.png
  - reveal-template.htm
  - skylighting-dark.css
  - skylighting-light.css
  - zettlr-dev.desktop
- - .gitignore
  - copy-folder.mjs
  - index.mjs
  - make-config.mjs
  - test-config.example.yml
- add-osx-cert.sh
- audit-report.sh
- console-colour.mjs
- develop-shortcut.mjs
- enforce-pr-structure.sh
- get-git-hash.js
- get-pandoc.sh
- i18n.sh
- lint-po.mjs
- split-vue-sfc.js
- update-citation.mjs
- update-csl.mjs
- update_apt.sh
- - app-service-container.ts
  - lifecycle.ts
- - data.json
  - i18n-main.ts
  - i18n-renderer.ts
  - regular-expressions.ts
- - config.ts
  - document-tree-store.ts
  - index.ts
  - lrt-store.ts
  - pomodoro-store.ts
  - statistics-store.ts
  - tags-store.ts
  - window-state-store.ts
  - workspace-store.ts
  - writing-targets-store.ts
- - App.vue
  - Debug-Tab.vue
  - Font-License-Tab.vue
  - General-Tab.vue
  - index.ts
  - License-Tab.vue
  - Projects-Tab.vue
  - Sponsors-Tab.vue
- - App.vue
  - CustomCSS.vue
  - DefaultsTab.vue
  - FilterTab.vue
  - index.ts
  - SnippetsTab.vue
- - App.vue
  - index.ts
- - App.vue
  - index.ts
  - LogMessage.vue
- - App.vue
  - DocumentTabs.vue
  - EditorBranch.vue
  - EditorPane.vue
  - GlobalSearch.vue
  - index.ts
  - MainEditor.vue
  - PopoverDocInfo.vue
  - PopoverExport.vue
  - PopoverLRT.vue
  - PopoverPandoc.vue
  - PopoverPomodoro.vue
  - PopoverStats.vue
  - PopoverTable.vue
  - PopoverTags.vue
  - tabs-context.ts
- - App.vue
  - index.ts
  - SupportLogos.vue
- - App.vue
  - index.ts
- - App.vue
  - index.ts
- - App.vue
  - index.ts
- - App.vue
  - index.ts
- - App.vue
  - index.ts
- - App.vue
  - CalendarView.vue
  - ChartView.vue
  - directed-graph.ts
  - FSALView.vue
  - generate-stats.ts
  - GraphView.vue
  - index.ts
- - App.vue
  - index.ts
- - App.vue
  - index.ts
- citeproc.d.ts
- global.d.ts
- main.ts
- nodehun.d.ts
- - locales-af-ZA.xml
  - locales-ar.xml
  - locales-bal-PK.xml
  - locales-bg-BG.xml
  - locales-brh-PK.xml
  - locales-ca-AD.xml
  - locales-cs-CZ.xml
  - locales-cy-GB.xml
  - locales-da-DK.xml
  - locales-de-AT.xml
  - locales-de-CH.xml
  - locales-de-DE.xml
  - locales-el-GR.xml
  - locales-en-GB.xml
  - locales-en-US.xml
  - locales-es-CL.xml
  - locales-es-ES.xml
  - locales-es-MX.xml
  - locales-et-EE.xml
  - locales-eu.xml
  - locales-fa-IR.xml
  - locales-fi-FI.xml
  - locales-fr-CA.xml
  - locales-fr-FR.xml
  - locales-gl-ES.xml
  - locales-he-IL.xml
  - locales-hi-IN.xml
  - locales-hr-HR.xml
  - locales-hu-HU.xml
  - locales-hy-AM.xml
  - locales-id-ID.xml
  - locales-is-IS.xml
  - locales-it-IT.xml
  - locales-ja-JP.xml
  - locales-km-KH.xml
  - locales-ko-KR.xml
  - locales-la.xml
  - locales-lij-IT.xml
  - locales-lt-LT.xml
  - locales-lv-LV.xml
  - locales-mn-MN.xml
  - locales-ms-MY.xml
  - locales-nb-NO.xml
  - locales-nl-NL.xml
  - locales-nn-NO.xml
  - locales-pa-PK.xml
  - locales-pl-PL.xml
  - locales-pt-BR.xml
  - locales-pt-PT.xml
  - locales-ro-RO.xml
  - locales-ru-RU.xml
  - locales-sk-SK.xml
  - locales-sl-SI.xml
  - locales-sr-Cyrl-RS.xml
  - locales-sr-Latn-RS.xml
  - locales-sr-RS.xml
  - locales-sv-SE.xml
  - locales-th-TH.xml
  - locales-tl-PH.xml
  - locales-tr-TR.xml
  - locales-uk-UA.xml
  - locales-vi-VN.xml
  - locales-zh-CN.xml
  - locales-zh-TW.xml
  - locales.json
- - chicago-author-date.csl
- - HTML to Markdown.yaml
  - HTML.yaml
  - LaTeX to Markdown.yaml
  - LaTeX.yaml
  - Markdown.yaml
  - Microsoft Word to Markdown.yaml
  - Microsoft Word.yaml
  - Open Document Text to Markdown.yaml
  - Open Document Text.yaml
  - OPML to Markdown.yaml
  - Orgmode to Markdown.yaml
  - pandoc-defaults-schema.json
  - Plain Text.yaml
  - reStructuredText to Markdown.yaml
  - Reveal.js.yaml
  - Rich Text Format.yaml
  - text2tags to Markdown.yaml
  - Textile to Markdown.yaml
  - Wiki to Markdown.yaml
  - XeLaTeX PDF.yaml
- - CrimsonText-Bold.woff2
  - CrimsonText-BoldItalic.woff2
  - CrimsonText-Regular.woff2
  - CrimsonText-RegularItalic.woff2
  - fonts.css
  - Inconsolata-Bold.woff
  - Inconsolata.woff
  - LiberationMono-Bold.woff
  - LiberationMono-BoldItalic.woff
  - LiberationMono-Italic.woff
  - LiberationMono-Regular.woff
  - SIL Open Font License.txt
- - ar-AR.po
  - ca-ES.po
  - cs-CZ.po
  - da-DA.po
  - de-DE.po
  - en-GB.po
  - en-US.po
  - eo-EO.po
  - es-ES.po
  - et-ET.po
  - eu-EU.po
  - fi-FI.po
  - fr-FR.po
  - hu-HU.po
  - id-ID.po
  - it-IT.po
  - ja-JP.po
  - kk-KZ.po
  - ko-KO.po
  - nl-NL.po
  - pl-PL.po
  - pt-BR.po
  - pt-PT.po
  - ro-RO.po
  - ru-RU.po
  - sv-SV.po
  - ta-IN.po
  - tr-TR.po
  - uk-UA.po
  - vi-VI.po
  - zh-CN.po
  - zh-TW.po
- - links.lua
  - tags.lua
- export.tpl.htm
- i18n.pot
- index.htm
- README.md
- - select-all.ts
- - add-spaces-around-emdashes.spec.ts
  - curl-quotes.spec.ts
  - double-quotes-to-single-quotes.spec.ts
  - italics-to-quotes.spec.ts
  - quotes-to-italics.spec.ts
  - remove-line-breaks.spec.ts
  - remove-spaces-around-emdashes.spec.ts
  - single-quotes-to-double-quotes.spec.ts
  - straighten-quotes.spec.ts
  - strip-duplicate-spaces.spec.ts
  - to-double-quotes.spec.ts
  - to-sentence-case.spec.ts
  - to-title-case.spec.ts
  - zap-gremlins.spec.ts
- build-pipe-table.spec.ts
- compile-search-terms.spec.ts
- counter.spec.ts
- css-safe-string.spec.ts
- database-loader.spec.ts
- disambiguate-file.spec.ts
- document-tree.spec.ts
- extract-bibtex-attachments.spec.ts
- extract-linefeed.spec.ts
- extract-yaml-frontmatter.spec.ts
- find-object.spec.ts
- format-date.spec.ts
- generate-toc.spec.ts.ignore
- graph.spec.ts
- hash.spec.ts
- is-function.spec.ts
- localise-number.spec.ts
- make-search-regex.spec.ts
- make-valid-uri.spec.ts
- markdown-to-ast.spec.ts
- move-section.spec.ts
- pandoc-reader-writer.spec.ts
- parse-equations.spec.ts.ignore
- parse-grid-tables.spec.ts.ignore
- parse-pandoc-attributes.spec.ts
- parse-pipe-tables.spec.ts.ignore
- persistent-data-container.spec.ts
- renderer-path-polyfill.spec.ts
- replace-links.spec.ts
- replace-string-variables.spec.ts
- replace-tags.spec.ts
- safe-assign.spec.ts
- setup.js
- shorten-url-visually.spec.ts
- snippets.spec.ts
.gitattributes
.gitignore
.mocharc.js
.yarnrc.yml
CHANGELOG.md
CITATION.cff
CODE_OF_CONDUCT.md
CONTRIBUTING.md
electron-builder.yml
eslint.config.mjs
forge.config.js
LICENSE
package.json
README.md
SECURITY.md
tsconfig.json
webpack.main.config.js
webpack.renderer.config.js
webpack.rules.js
yarn.lock

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# [Zettlr](https://github.com/Zettlr/Zettlr) Zettlr [*ˈset·lər*]

**올인원 출판 워크벤치**.

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2580173.svg)](https://doi.org/10.5281/zenodo.2580173)
[![License: GNU GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![GitHub tag (latest by date)](https://img.shields.io/github/tag-date/Zettlr/Zettlr.svg?label=latest)](https://www.zettlr.com/download)
![GitHub All Releases](https://img.shields.io/github/downloads/Zettlr/Zettlr/total.svg)
![Unit Tests / Lint](https://github.com/Zettlr/Zettlr/actions/workflows/check.yml/badge.svg)
![Build](https://github.com/Zettlr/Zettlr/workflows/Build/badge.svg)

![screenshot](https://raw.githubusercontent.com/Zettlr/Zettlr/develop/resources/screenshots/zettlr\_view.png)
Zettlr는 텍스트 작성에 간편함을 되찾아 줍니다. 사용자의 스타일에 적응하는 열린 사고의 글쓰기 환경을 제공합니다. 중요한 정보를 빠르게 찾아주는 정보 검색 기능과, 고용주나 학교가 요구하는 어떠한 발행 파이프라인에도 적응할 수 있는 다기능 내보내기를 지원합니다.
자신에게 중요한 것에 집중하세요.
\*\*쓰거나, 도태되거나 (Publish, not perish).\*\*
> [웹사이트에서 자세히 알아보기](https://zettlr.com/).
\*\*\*
\*\*목차\*\*
- [기능](#features)
- [시작하기](#getting-started)
- [소스코드 빌드하기](#building-from-source)
- [기여하기](#contributing)
- [시작하기](#getting-started-1)
- [기술 스택](#tech-stack)
- [디버깅](#debugging)
- [아키텍처 개요](#architecture-overview)
- [개발 명령어](#development-commands)
- [빌드 플래그](#build-flags)
- [디렉터리 구조](#directory-structure)
- [명령줄 스위치](#command-line-switches)
- [VSCode 확장 프로그램 추천](#vscode-extension-recommendations)
- [라이선스](#license)
## 기능
- 내 노트는 온전히 나의 것: Zettlr는 \*\*프라이버시 우선(privacy-first)\*\* 철학을 따릅니다.
- 손쉬운 \*\*참고문헌 인용\*\*: 선호하는 참고문헌 관리자(Zotero, JabRef 등)와 긴밀하고 지속적으로 통합됩니다.
- 12개 이상의 \*\*다양한 언어\*\* 지원
- \*\*LaTeX 및 Word 템플릿 지원\*\*을 통해 전문가 수준의 출판물 초안 작성
- [Pandoc](https://pandoc.org/), [LaTeX](https://www.latex-project.org/), [Textbundle](http://textbundle.org/)을 통한 간단하고 아름다운 내보내기
- \*\*스니펫(Snippets)\*\*을 통한 상용구 코드 자동 삽입
- 테마, 다크 모드, 그리고 \*\*사용자 지정 CSS\*\*를 통한 완전한 유연성 제공
- 다양한 언어에 대한 \*\*코드 하이라이팅\*\*
- 최첨단 지식 관리 기법(\*\*제텔카스텐(Zettelkasten)\*\*) 지원
- 언제 어디서나 무엇이든 찾을 수 있도록 도와주는 강력한 \*\*전문 검색(full text search)\*\* 기능
… 그리고 가장 좋은 점은: \*\*Zettlr는 [자유 오픈 소스 소프트웨어(FOSS)](https://en.wikipedia.org/wiki/Free\_and\_open-source\_software)입니다!\*\*
## 시작하기
[최신 릴리스를 다운로드](https://www.zettlr.com/download/)한 후 일반적인 앱처럼 설치하세요. 현재 macOS, Windows 및 대부분의 Linux 배포판을 지원합니다.
웹사이트와 GitHub에서는 가장 일반적인 사용 사례를 위한 설치 프로그램을 제공합니다. 64비트 설치 프로그램과 ARM 시스템용 설치 프로그램(macOS 생태계에서는 "Apple Silicon"이라고 부름)을 모두 제공합니다. 32비트는 지원하지 않습니다. 다음과 같은 바이너리를 직접 제공합니다:
\* macOS (Intel 및 Apple Silicon)
\* Windows (x64)
\* Debian/Ubuntu (x64 및 ARM)
\* Fedora/Red Hat (x64 및 ARM)
\* AppImage (x64 및 ARM)
커뮤니티의 도움 덕분에 패키지 매니저를 통해 다음과 같은 다양한 설정 방식도 제공할 수 있습니다:
\* [Homebrew (macOS)](https://formulae.brew.sh/cask/zettlr)
\* [Aptitude (Ubuntu/Debian)](https://apt.zettlr.com)
\* [Flathub (Linux)](https://flathub.org/apps/details/com.zettlr.Zettlr)
\* [Chocolatey (Windows)](https://community.chocolatey.org/packages/zettlr/)
\* [Arch Linux](https://wiki.archlinux.org/title/Zettlr)
[Electron이 지원하는 다른 모든 플랫폼](https://www.electronjs.org/docs/latest/development/build-instructions-gn#platform-prerequisites)도 지원되지만, 이 경우 앱을 직접 빌드해야 합니다.
> [!TIP]
> Zettlr는 커뮤니티의 기부로 전적으로 지원됩니다. 일회성 기부나 월간 기부를 하실 수 있습니다. [웹사이트에서 자세히 알아보세요](https://www.zettlr.com/supporters).
> 감사합니다!
Zettlr를 설치한 후, [문서 페이지로 이동하여](https://docs.zettlr.com/) Zettlr에 대해 알아보세요. 앱에는 기본 사항을 다루는 간단한 튜토리얼이 포함되어 있습니다.
Zettlr가 처음이시라면
[초보자 가이드](https://docs.zettlr.com/en/first-time-users/first-steps/)를 참고하세요.
또한 앱의 모든 내보내기 프로필을 활성화하려면
[LaTeX 설치](https://docs.zettlr.com/en/getting-started/installing-latex/)를 고려해 보세요.
![다크 테마를 사용 중인 Zettlr의 중앙 창

eme](https://raw.githubusercontent.com/Zettlr/Zettlr/develop/resources/screenshots/zettlr\_view\_dark.png)
## 소스 코드에서 빌드하기
원하시는 경우 직접 앱을 컴파일할 수 있습니다. 이를 위해 아래의 개발 가이드를 참조하여 필요한 모든 종속성이 설치되어 있는지 확인하세요.
그런 다음 `yarn package` 명령어를 사용하여 컴퓨터용 앱을 빌드할 수 있습니다.
## 기여하기
오픈 소스 애플리케이션인 Zettlr는 항상 커뮤니티의 기여를 환영합니다. \*\*기여하기 위해 코딩 방법을 알 필요는 없습니다!\*\* 기여할 수 있는 모든 분야에 대한 자세한 개요는 [기여 가이드](./CONTRIBUTING.md)에서 확인할 수 있습니다. 아래에서는 Zettlr 소스 코드를 로컬에 설정하는 방법을 소개합니다.
### 시작하기
Zettlr는 [Electron](https://www.electronjs.org/) 기반 앱입니다. 개발을 시작하려면 컴퓨터에 다음 항목이 설치되어 있어야 합니다:
1. [NodeJS](https://nodejs.org/). 버전이 최소 Node 22 (`lts/jod`) 이상인지 확인하세요.
설치된 버전을 테스트하려면 `node -v`를 실행하세요.
2. [Yarn](https://yarnpkg.com/en/). 이 프로젝트의 패키지 매니저로, `package-lock.json` 파일을 커밋하지 않으며 많은 명령어에 yarn이 필요하기 때문입니다.
macOS를 사용하는 경우 `npm install -g yarn` 또는 Homebrew를 사용하여 전역으로 설치할 수 있습니다.
3. Windows의 경우, 다음 단계들을 훨씬 쉽게 만들어 주는 [Windows Subsystem for Linux (WSL) 설치](https://learn.microsoft.com/en-us/windows/wsl/install)를 권장합니다.
4. 개발 빌드를 실행하는 데 다양한 스크립트가 필요로 하는 몇 가지 명령줄 유틸리티:
\* [`cURL`](https://curl.se/download.html) (Pandoc 다운로드 스크립트에 필요)
\* `unzip` (Pandoc 다운로드 스크립트에 필요)
\* [`jq`](https://jqlang.github.io/jq/) (i18n 스크립트에 필요)
5. Zettlr는 앱을 실행하기 전에 컴파일해야 하는 몇 가지 네이티브 C++ 모듈이 필요하므로 운영체제에 적합한 빌드 도구 체인:
\* \*\*macOS\*\*: macOS에서는 `xcode-select --install`을 통해 XCode 명령줄 도구를 설치하는 것으로 충분합니다.
\* \*\*Windows\*\*: Windows의 경우 필요한 도구가 포함된 [무료 Visual Studio 개발 도구](https://visualstudio.microsoft.com/free-developer-offers/)가 필요합니다.
\* \*\*Linux\*\*: Linux에는 다양한 호환 도구 체인이 있으며, 이미 사전 설치되어 있는 경우도 있습니다. 자세한 내용은 배포판 설명서를 참조하세요.
그런 다음, 간단히 저장소를 복제하고 로컬 컴퓨터에 종속성을 설치하면 됩니다:
```bash
git clone https://github.com/Zettlr/Zettlr.git
cd Zettlr
yarn install --immutable
```
> [!CAUTION]
> 반드시 `--immutable` 플래그와 함께 `yarn install`을 실행하세요. 이렇게 하면 yarn이 `yarn.lock`에 나열된 버전을 유지하고 업데이트를 시도하지 않도록 보장합니다. 이는 컴퓨터를 감염시킬 수 있는 공급망 공격을 예방하는 데 도움이 됩니다.
개발하는 동안 핫 모듈 리로딩(HMR)이 활성화되어 있으므로 렌더러의 코드를 쉽게 수정하고 `electron-forge`를 통해 변경 사항이 컴파일된 후 `F5`를 누를 수 있습니다. 개발자 도구를 열어두면 HMR이 변경 사항 로딩을 완료한 시점을 확인할 수 있습니다.
### 기술 스택
Zettlr는 Electron, Node.js, 그리고 프론트엔드를 위한 Vue 등 세 가지 기술 스택을 기반으로 합니다.
코드를 제공하려면 다음 주제 및/또는 설명서(중요도 내림차순)에 대한 기본적인 친숙함이 있어야 합니다:
\* [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) (특히 비동기 코드) 및 [TypeScript](https://www.typescriptlang.org/docs/)
\* [Node.js](https://nodejs.org/api/)
\* [Electron](https://www.electronjs.org/docs)
\* [Vue.js 3.x](https://vuejs.org/guide/introduction.html) 및 [Pinia](https://pinia.vuejs.org/)
\* [CodeMirror 6.x](https://codemirror.net/docs/)
\* [ESLint](https://eslint.org/)
\* [Webpack 5.x](https://webpack.js.org/concepts/)
\* [Electron forge](https://www.electronforge.io/)
\* [Electron builder](https://www.electron.build/)
### 디버깅
Zettlr는 `.vscode/la`의 구성을 기반으로 VS Code 내에서 완전한 디버깅 지원을 제공합니다.

unch.json`. 디버깅 사이드바에서 직접 디버깅 세션을 시작할 수 있습니다. 메인 프로세스를 디버깅하거나 개별 렌더러 프로세스에 디버거를 연결할 수 있습니다.
> [!TIP]
> VS Code에서의 디버깅에 대해 자세히 알아보려면
> [공식 가이드](https://code.visualstudio.com/docs/debugtest/debugging)를 읽어보세요.
### 아키텍처 개요
Electron 앱으로서 Zettlr는 하나의 메인 프로세스와 여러 개의 렌더러 프로세스(후자는 개별 창에 해당함)로 구분되는 특성을 이어받습니다. 여기에 더해 Zettlr는 비교적 고전적인 서버/싱글 페이지 애플리케이션(SPA) 패턴을 구현합니다. 여기서 메인 프로세스는 애플리케이션 창들을 조율하고(각각을 독립적인 개별 SPA로 생각할 수 있음) 창들과 운영 체제 간의 브리지 역할을 하는 서버로서 기능합니다.
모든 메인 프로세스 코드는 `source/app` 디렉터리에 있으며, 여기에는 다음 세 부분이 포함됩니다.
1. 부팅 전 환경 검사를 수행하고 앱의 시작 및 종료를 용이하게 하는 `lifecycle.ts` 모듈.
2. 기본 애플리케이션 서비스 컨테이너를 포함하는 `app-service-container.ts` 파일.
3. `service-providers` 폴더 내의 다양한 서비스 제공자들로, 모두 싱글톤으로 구현된 클래스들입니다.
부팅 중에 라이프사이클 모듈은 환경 검사를 수행한 다음 애플리케이션 서비스 컨테이너를 로드하고, 이 컨테이너는 차례대로 모든 서비스 제공자 싱글톤을 로드합니다. 이들은 앱이 실행되는 동안 계속해서 활성 상태를 유지하며 실행됩니다. 이들은 렌더러 프로세스의 요청을 처리하고(Electron의 IPC 모듈을 통해 구현됨), 테마나 파일 변경 등의 운영 체제벤트를 모니터링합니다.
개별 렌더러 프로세스, 즉 창들은 서비스 제공자인 `WindowManager`에 의해 관리됩니다. 요청에 따라 이 관리자는 새로운 `BrowserWindow`를 인스턴스화하고 해당 창 역할을 하는 SPA의 올바른 진입점을 로드합니다.
렌더러는 일반적인 SPA와 비교하여 다음과 같은 세 가지 주목할만한 차이점이 있는 완전한 기능의 SPA입니다.
1. `fetch`를 사용하여 API와 통신하는 대신, IPC 모듈을 통해 메인 프로세스와 통신합니다. 이는 연결을 먼저 인스턴스화할 필요가 없다는 점을 제외하면 기본적으로 웹소켓과 유사하게 작동합니다.
2. IPC 통신은 동일한 프리로드 스크립트(`source/common/modules/preload`)를 사용하여 모든 창에 주입됩니다.
3. 웹사이트 레이아웃 대신 데스크톱 디자인 원칙에 따라 정렬된 Vue 모듈을 사용하여 데스크톱 중심적인 방식으로 구현되어 있습니다.
### 개발 명령어
이 섹션에서는 애플리케이션 개발 중에 사용할 수 있는 모든 사용 가능한 명령어를 나열합니다. 이들은 `package.json`에 정의되어 있으며 명령어 앞에 `yarn`을 붙여 커맨드 라인에서 실행할 수 있습니다. 리포지토리의 기본 디렉터리 내에서 실행하세요.
#### `start`
애플리케이션에 적용한 변경 사항을 안심하고 테스트하려면 이 명령어를 사용하세요. 이 명령어는 애플리케이션을 시작하지만 사용자 정의 설정과 사용자 정의 디렉터리를 제공합니다. 따라서 일반적인 Zettlr 설치가 사용하는 어떤 파일도 건드리지 않습니다.
> [!CAUTION]
> \*\*이 명령어를 처음 시작할 때\*\* `--clean` 플래그를 전달하여 `./resources` 디렉터리에 테스트 파일들을 복사하고, 프로젝트 루트에 `test-config.yml`을 생성한 후, 이 깨끗한 설정으로 애플리케이션을 시작하세요. 그런 다음 원하는 대로 `test-config.yml`을 조정할 수 있습니다(기본 설정을 열지 않고도 \*항상\* 설정할 특정 값들이 미리 설정되도록 함).
테스트 디렉터리를 초기 상태로 재설정하고 싶을 때마다(또는 디렉터리를 삭제했거나 전체 프로젝트를 새로 클론한 경우) 명령어에 `--clean` 플래그를 전달하여 디렉터리를 생성하거나 재설정하세요.
\*\*`test-config.yml`에서 무언가를 변경한 경우에도 이 작업이 필요합니다\*\*.
설정 파일이 생성되는 것을 방지하려면(예: 최초 시작 경험을 시뮬레이션하기 위해) `--no-config` 플래그를 이 명령어에 전달하세요.
[커맨드 라인 스위치](#command-line-switches)와 같은 추가 인수를 전달할 수 있습니다.

도 `--clear-cache`에도 적용됩니다. 이 인수들은 자식 프로세스로 전달됩니다.
추가로 당사의
[전체 개발 문서](https://docs.zettlr.com/en/getting-started/get-involved/)를 확인해 보세요.
#### `package`
애플리케이션을 패키징하지만 설치 프로그램으로 번들링하지는 않습니다. 접미사 없이 이 명령을 실행하면 현재 플랫폼 및 아키텍처용으로 애플리케이션이 패키징됩니다. 특정 패키지를 생성하려면(해당 플랫폼에서 실행해야 할 수 있음) 다음 접미사를 사용할 수 있습니다.
- `package:mac-x64` (Intel 기반 Mac)
- `package:mac-arm` (Apple Silicon 기반 Mac)
- `package:win-x64` (Intel 기반 Windows)
- `package:linux-x64` (Intel 기반 Linux)
- `package:linux-arm` (ARM 기반 Linux)
생성된 애플리케이션 패키지는 `./out`에 저장됩니다.
> [!IMPORTANT]
> 이 명령은 빌드 속도를 높이기 위해 타입 검사를 건너뛰므로, 오류가 없도록 패키징하기 전에 `lint`를 실행하는 것을 권장합니다.
#### `release:{platform-arch}`
애플리케이션을 패키징한 후 해당 플랫폼 및 아키텍처용 설치 프로그램으로 번들링합니다. 이러한 번들을 생성하려면(해당 플랫폼에서 실행해야 할 수 있음) `{platform-arch}`에 다음 값 중 하나를 지정해야 합니다.
- `release:mac-x64` (Intel 기반 Mac)
- `release:mac-arm` (Apple Silicon 기반 Mac)
- `release:win-x64` (Intel 기반 Windows)
- `release:linux-x64` (Intel 기반 Linux)
- `release:linux-arm` (ARM 기반 Linux)
생성된 설치 번들은 `./release`에 저장됩니다.
> [!NOTE]
> 접미사 없이 플랫폼용으로 직접 `package`를 실행할 수도 있지만, 릴리스 번들을 생성할 때는 플랫폼과 아키텍처를 지정해야 합니다. 그렇지 않으면 electron-builder가 개발 의존성(development-dependencies)을 `app.asar`에 포함하여 애플리케이션 용량이 불필요하게 커지기 때문입니다.
#### `csl:refresh`
애플리케이션과 함께 배포되는 [Citation Style Language](https://citationstyles.org/) (CSL) 파일을 다운로드하여 각각 `static/csl-locales` 및 `static/csl-styles` 디렉터리에 배치합니다.
> [!NOTE]
> 이 명령은 이 작업을 수행하기 위해 리포지토리에서 주기적으로 실행되는 자동화된 워크플로를 위한 것입니다.
> \*\*업데이트된 파일을 리포지토리에 커밋하지 마세요\*\*. 대신, `git fetch`를 실행할 때마다 업데이트된 파일이 다운로드됩니다.
#### `lint`
`lint:code`와 `lint:types`를 한 번에 모두 실행합니다. 이를 통해 추가한 모든 코드가 스타일 규칙을 준수하고 명백한 오류 없이 실행될 수 있음을 보장합니다. Pull Request를 제출하기 전에 이 명령을 반드시 실행하세요.
> [!NOTE]
> 이 명령은 코드의 일관성을 검사하기 위해 각 Pull Request마다 자동으로 실행됩니다.
#### `lint:code`
코드베이스에 대해 [ESLint](https://eslint.org/)를 실행합니다. [Visual Studio Code](https://code.visualstudio.com/)와 같은 앱은 열려 있는 파일에 대해 백그라운드에서 자동으로 ESLint를 실행합니다. 이 명령은 전체 코드베이스에 걸쳐 이를 실행합니다.
> [!TIP]
> 일반적으로는 `lint` 명령을 실행하는 것을 선호할 것입니다.
#### `lint:types`
코드베이스에 대해 [`vue-tsc`](https://www.npmjs.com/package/vue-tsc)를 통해 TypeScript의 타입 체커를 실행합니다. [Visual Studio Code](https://code.visualstudio.com/)와 같은 앱은 백그라운드에서 열려 있는 파일의 타입을 자동으로 검사합니다. 이 명령은 전체 코드베이스를 검사합니다.
> [!TIP]
> 일반적으로는 `lint` 명령을 실행하는 것을 선호할 것입니다.
#### `lint:po`
이 명령은 `static/lang` 디렉터리의 모든 번역 파일이 앱에서 파싱될 수 있도록 보장합니다. Zettlr에 포함된 `gettext` 파서로 이를 파싱하여 수행됩니다. 이 명령은 Node 모듈만 사용하므로 시스템에 `gettext` 시스템 자체가 설치되어 있을 필요가 없습니다.
> [!NOTE]
> 이 명령은 `\*.po` 파일을 건드리는 pull request에서 자동으로 실행됩니다.
#### `shortcut:install`
소스에서 컴파일한 앱을 빠르게 시작할 수 있도록 애플리케이션에 `.desktop` 파일을 생성합니다. 이 기능은 Linux가 필요합니다. 새로운 변경 사항을 사용하려면 단순히 리포지토리를 동기화하고, `package`를 다시 실행하기만 하면 바로 사용할 수 있습니다.
> [!WARNING]
> 우리는

편의를 위해 이 명령어를 제공합니다. 무엇을 하고 있는지 잘 알고 있는 경우가 아니라면,
> develop 브랜치의 HEAD 커밋에서 직접 컴파일된 코드를 실행해서는 안 됩니다.
> 하지만 이 명령어는 무엇이 잘못될 수 있는지 알고 있고 적절한 예방 조치를
> 취할 수 있는 몇 가지 경우에 유용할 \*수\*는 있습니다.
#### `shortcut:uninstall`
`shortcut:install`을 통해 생성된 `.desktop` 파일을 제거합니다.
> [!NOTE]
> 바이너리를 새로 컴파일할 때마다 단축키를 제거하고 다시 설치할 필요는 없습니다.
> 단지 재컴파일하기 전에 Zettlr가 종료되어 있는지 확인하기만 하면 됩니다.
> 템플릿(`scripts/assets/zettlr-dev.desktop`에 위치)이 변경된 경우에만
> 단축키를 다시 설치해야 합니다.
#### `test`
`./test` 디렉터리의 유닛 테스트를 실행합니다. Pull Request를 제출하기 전에
이 명령어를 반드시 실행하세요. PR에 커밋할 때마다 이 테스트가 실행되므로,
변경 사항으로 인해 테스트가 깨지지 않는지 미리 확인하여 전체 PR 과정을
더 원활하게 만들 수 있습니다.
#### `test-gui`
`start`를 참고하세요.
> [!IMPORTANT]
> 이 명령어는 더 이상 사용되지 않으며(deprecated) `start`의 별칭(alias)일 뿐입니다.
> 대신 `start`를 사용하세요.
### 빌드 플래그 (Build Flags)
Zettlr의 빌드 과정은 최종 바이너리에 특정 동작을 하드코딩하는 데 사용할 수 있는
빌드 플래그를 지원합니다. 이들은 주로 환경 변수 형태로 제공됩니다.
이러한 환경 변수가 존재할 경우, Zettlr는 일반적이지 않은 바이너리를 생성합니다.
#### `ZETTLR\_DISABLE\_UPDATE\_CHECK`
빌드 중에 이 환경 변수가 존재하면, 생성되는 바이너리의 내장 업데이트 확인
메커니즘이 비활성화됩니다. 이는 패키지 매니저를 통해 배포하기 위해 앱을
다시 패키징하는 경우에 유용합니다. 빌드 스크립트는 바이너리에 업데이트
확인 기능이 활성화되지 않는다는 경고를 출력합니다.
빌드 시점에 업데이트 확인을 비활성화하려면, 단순히 이 환경 변수가 존재하도록
설정하기만 하면 됩니다. 빌드 스크립트는 실제 값은 확인하지 않고 변수의 존재
여부만 확인합니다. 업데이트 확인 메커니즘이 포함되도록 하려면, 빌드 스크립트를
실행하기 전에 `unset ZETTLR\_DISABLE\_UPDATE\_CHECK`를 실행하는 등의 방법으로
이 환경 변수가 설정되어 있지 \*않음을\* 확실히 하세요.
> [!CAUTION]
> 업데이트 확인 기능이 비활성화된 Zettlr 버전을 생성하여 배포하는 경우, 사용자가
> 다른 메커니즘을 통해 Zettlr 업데이트를 받을 수 있도록 보장할 책임은 귀하에게
> 있습니다. 귀하는 업데이트 메커니즘이 항상 안정적으로 작동하도록 보장할 책임이
> 있음을 인정합니다. 어떤 이유로든(일시적인 경우라도) 업데이트 메커니즘이 중단되어
> Zettlr 사용자가 새로운 업데이트를 받을 수 없는 경우, 귀하는 GitHub Issue,
> Discord 또는 이메일을 통해 즉시 당사에 이 사실을 통지해야 \*\*합니다\*\*.
> \*\*이러한 추가 요구 사항을 준수하지 않을 경우, 수정된 Zettlr 버전 배포에 대한 당사의 묵시적 동의가 즉시 철회됩니다.\*\*
> 작동하는 업데이트 메커니즘 없이 Zettlr의 특정 버전이 공개 배포되었다는 통지를
> 받았음에도 귀하가 이를 당사에게 직접 알리지 않는 경우, 당사는 즉시 사용자들에게
> 귀하의 Zettlr 패키지에 대해 공개적으로 경고하고 Zettlr 배포에 대한 묵시적 동의를
> 철회할 것입니다. 따라서 귀하는 Zettlr를 배포할 수 있는 권한을 무기한 박탈당하게
> 됩니다. 요약하자면: 무엇을 하고 있는지 \*\*정확히\*\* 알고 있는 경우에만 이 빌드
> 플래그를 사용하고, 문제가 발생할 경우 선제적으로 소통하십시오. 그러면 모든 것이
> 원만할 것입니다.
#### `BUNDLE\_PANDOC`
빌드 중에 이 환경 변수가 존재하면, 빌드 스크립트는 올바른 Pandoc 바이너리를
최종 애플리케이션 번들에 포함시키지 \*\*않습니다\*\*(`not`). 이는 패키지 매니저를
통해 배포하기 위해 앱을 다시 패키징하고 Pandoc이 Zettlr의 종속성으로 설치되도록
보장하려는 경우에 유용합니다. 빌드 스크립트는 바이너리에 Pandoc이 번들로
포함되지 않는다는 경고를 출력합니다.
Pandoc 번들링을 비활성화하려면 환경 변수를 `0`으로 설정해야 합니다.
예: `export BUNDLE\_PANDOC=0`. 이렇게 하면 빌드 스크립트가 Pandoc을 다운로드
하거나 번들로 포함하지 않게 됩니다. (이는 또한 빌드 환경이 특정 요건으로부터

irements for the Pandoc download script identified above.)
> [!CAUTION]
> Zettlr 사용자들은 Pandoc이 설치되어 있을 것을 기대합니다. 그렇지 않으면 파일을 가져오거나 내보낼 수 없기 때문입니다. 따라서 공개적으로 배포되는 모든 Zettlr 버전은 Pandoc이 번들로 포함되어 있거나, 다른 메커니즘을 통해 컴퓨터에 Pandoc이 설치되도록 보장해야 합니다. 앱을 재패키징하면서 이 빌드 플래그를 사용하고 이를 패키지 관리자를 통해 배포하는 경우, 다른 수단(예: Pandoc을 Zettlr의 의존성으로 지정하는 방식 등)을 통해 Pandoc이 Zettlr과 함께 반드시 설치되도록 **해야 합니다**. 우리는 사용자들이 특정 Zettlr 버전에서 내보내기나 가져오기가 작동하지 않는다고 불평하기를 원하지 않습니다.
> **이러한 추가 요구사항을 준수하지 않을 경우, 수정된 Zettlr 버전을 배포할 수 있는 당사의 암묵적 동의는 즉시 철회됩니다.**
> 따라서 Zettlr을 배포할 수 있는 권한을 무기한 박탈당하게 됩니다. 요약하자면: 자신이 무엇을 하고 있는지 **정확히** 알고 있는 경우에만 이 빌드 플래그를 사용하세요. 그렇다면 모든 것이 좋습니다.
### 디렉토리 구조
Zettlr은 개발 과정에서 수백 개의 디렉토리가 축적된 성숙한 앱입니다. 아무런 가이드 없이 애플리케이션에 기여하기는 어려우므로, 디렉토리들에 대한 간단한 설명과 상호 연관성을 정리해 두었습니다.
```
.
├── out # Contains packaged apps (without the installer)
├── release # Contains packaged apps with the installer
├── resources # Resources for the app
│ ├── icons # Icons for the app in various sizes
│ ├── liquid-glass # The macOS Liquid Glass icon
│ ├── NSIS # NSIS installer pictures
│ ├── screenshots # The screenshots you can see in this file
├── scripts # Various scripts; should be called via `yarn`
├── source # Contains all source files
│ ├── app # Main process code
│ │ └── service-providers # Service providers (singletons)
│ │ ├── appearance # Appearance-related functionality
│ │ ├── assets # Assets (export profiles, custom CSS, etc.)
│ │ ├── citeproc # Citation management
│ │ ├── commands # Various commands that the user can execute
│ │ ├── config # The main configuration
│ │ ├── css # Custom CSS provider
│ │ ├── dictionary # Hunspell provider
│ │ ├── documents # Main document editing hub
│ │ ├── fsal # File-System Abstraction Layer
│ │ ├── links # Zettelkasten-Link and interlinking management
│ │ ├── log # Logging
│ │ ├── long-running-tasks # Long-Running Task indication management
│ │ ├── menu # Application menus
│ │ ├── recent-docs # Recent documents
│ │ ├── search # Full-text search
│ │ ├── stats # Writing statistics
│ │ ├── tags # Tagging management
│ │ ├── targets # Writing targets
│ │ ├── tray # Tray icon management
│ │ ├── updates # Checks for updates
│ │ └── windows # Manages all application windows
│ ├── common # Shared modules
│ │ ├── modules # Various renderer modules
│ │ │ ├── markdown-editor # The primary Markdown editor
│ │ │ ├── markdown-utils # Markdown converters and AST
│ │ │ ├── persistent-data-container # Data structure used in the main process
│ │ │ ├── preload # Shared renderer process hooks
│ │ │ ├── trusted-types # Trusted Types
│ │ │ └── window-register # Shared initialization function for the SPAs
│ │ ├── pandoc-util # Various utilities for running Pandoc
│ │ ├── util # Utility functions
│ │ └── vue # Shared Vue components
│ │ ├── form # Form builder
│ │ ├── iris-indicator-utils # Shader code for the Iris Indicator
│ │ └── window # Window Chrome
│ ├── pinia # SPA State management
│ ├── types # Shared types (deprecated)
│ ├── win-about # "About" window
│ ├── win-assets # Assets manager
│ ├── win-error # Custom error modal
│ ├── win-log-viewer # Log viewer
│ ├── win-main # Primary application window
│ ├── win-onboarding # Onboarding dialog
│ ├── win-paste-image # Paste-image modal
│ ├── win-preferences # Settings window
│ ├── win-print # Print preview
│ ├── win-project-properties # Project properties dialog
│ ├── win-splash-screen # Splash screen
│ ├── win

-stats # 그래프 뷰가 있는 통계 창
│ ├── win-tag-manager # 태그 관리자
│ └── win-update # 업데이트 대화상자
├── static # 빌드 중에 애플리케이션에 포함되는 정적 파일
│ ├── csl-locales # CSL 번역
│ ├── csl-styles # CSL 스타일
│ ├── defaults # 내보내기 프로필
│ ├── dict # hunspell 사전 모음
│ ├── fonts # 글꼴
│ ├── lang # 앱 번역
│ ├── lua-filter # 내보내기를 위한 Lua 필터
│ └── tutorial # 언어별로 정렬된 튜토리얼 파일
└── test # 단위 테스트
```
## 명령줄 스위치
개발 중이든 릴리스 빌드이든, Zettlr 바이너리는 다양한 목적으로 사용할 수 있는 몇 가지 명령줄 스위치를 제공합니다.

#### `--launch-minimized`
이 CLI 플래그는 Zettlr가 시작 시 메인 창을 표시하지 않도록 지시합니다. 이는 자동 시작 항목을 만드는 데 유용합니다. 이 경우 시스템 부팅 시 이 플래그와 함께 Zettlr를 실행하면 트레이에서 아이콘만 볼 수 있게 됩니다. 이와 같이 앱을 시작할 때 앱이 트레이 바나 알림 영역에서 계속 실행되어야 함을 의미하므로, 해당 설정인 `system.leaveAppRunning`을 자동으로 `true`로 설정합니다.

> [!NOTE]
> 이 플래그는 트레이 바나 알림 영역에 아이콘 표시를 지원하지 않는 Linux 시스템에서는 작동하지 않습니다.

#### `--clear-cache`
이 스위치는 파일 시스템 추상화 계층(File System Abstraction Layer)에 부팅 시 캐시를 완전히 지우도록 지시합니다. 이는 코드베이스 변경과 관련된 문제를 해결하는 데 사용할 수 있습니다. 캐시에 저장된 정보의 변경 사항과의 호환성을 보장하기 위해, `config.json`의 버전 필드가 `package.json`의 버전 필드와 일치하지 않을 때도 캐시가 자동으로 지워집니다. 즉, `test-config.yml`에서 `version` 필드를 명시적으로 설정하지 않는 한, `yarn start`를 입력할 때마다 실행 시마다 캐시가 항상 지워집니다.

> [!TIP]
> "도움말" 메뉴에서 적절한 항목을 선택하고 Zettlr를 다시 시작하면, 이 플래그가 전달된 상태로 자동으로 시작되므로 기술적 지식이 없는 사용자를 위해서도 캐시를 정리해 줍니다.

#### `--data-dir=path`
구성 파일이 저장되는 사용자 지정 데이터 디렉터리를 지정하려면 이 스위치를 사용하세요. 이 스위치가 없으면 데이터 디렉터리는 기본적으로 `%AppData%/Zettlr`(Windows 10 이상), `~/.config/Zettlr`(Linux), 또는 `~/Library/Application Support/Zettlr`(macOS)로 설정됩니다. 경로는 절대 경로일 수도 있고 상대 경로일 수도 있습니다. 상대 경로의 기준은 (패키지화된 앱을 실행 중인 경우) 바이너리의 디렉터리이거나 (패키지화되지 않은 앱을 실행 중인 경우) 저장소 루트가 됩니다. 필요한 경우 공백을 이스케이프하거나 경로를 따옴표로 감싸야 합니다. 홈 디렉터리를 나타내는 `~` 문자는 이 경우 확장되지 않으므로, 필요한 경우 홈 디렉터리의 전체 경로를 전달해야 합니다. Electron의 사소한 버그로 인해 기본 데이터 디렉터리에 빈 `Dictionaries` 하위 디렉터리가 생성되지만 기능에는 영향을 미치지 않습니다.

#### `--disable-hardware-acceleration`
이 스위치는 Zettlr가 하드웨어 가속을 비활성화하도록 하며, 특정 설정에서는 이 기능이 필요할 수 있습니다. 이 플래그가 추가된 이유에 대한 자세한 내용은 이슈 [#2127](https://github.com/Zettlr/Zettlr/issues/2127)을 참조하세요.

## VS Code 확장 프로그램 추천
이 저장소는 Visual Studio Code의 [권장 확장 프로그램 기능](https://go.microsoft.com/fwlink/?LinkId=827846)을 사용합니다. 즉, VS Code를 사용하고 저장소를 처음 열면, VS Code에서 몇 가지 확장 프로그램을 설치하는 것을 권장한다고 알려줍니다. 이 확장 프로그램들은 Zettlr로 작업을 할 때 권장되며 기여를 훨씬 더 쉽게 만들어 줍니다. 권장 사항은 `.vscode/extensions.json` 파일에 지정되어 있습니다.

확장 프로그램 설치는 때때로 개인 취향의 문제이므로, 우리는 각 권장 확장 프로그램이 추천되는 이유를 설명하기 위해 해당 파일에 간단한 설명을 추가했습니다. 이렇게 하면 이러한 확장 프로그램을 설치할지 여부를 스스로 결정할 수 있습니다(예를 들어 SVG 확장은 필수적이진 않습니다).

필요한 경우
(저장소에 제공된 SVG 파일을 다루지 않는 경우).
권장하는 모든 확장 프로그램을 한 번에 설치하지 않기로 선택하는 경우(저장소에서는 한 번에 설치하는 것을 권장합니다), VS Code의 확장 프로그램 사이드바에 추천 항목이 표시되므로, 먼저 설치하고 싶은 것을 결정한 후 원하는 것만 수동으로 설치할 수 있습니다.
> [!TIP]
> 코어 개발팀과 동일한 확장 프로그램을 사용하면 동일한 시각적 피드백을 얻을 수 있으므로 코드가 전반적으로 더 일관성 있게 유지됩니다.
## 라이선스
이 소프트웨어는 [GNU GPL v3-License](https://www.gnu.org/licenses/gpl-3.0.en.html)에 따라 라이선스가 부여됩니다.
브랜드(이름, 아이콘 및 Zettlr를 식별할 수 있는 모든 것 포함)는 제외되며 모든 권리가 유보됩니다. 다른 앱을 개발하기 위해 Zettlr를 포크(fork)하는 것은 자유이지만, 이름과 아이콘은 변경해 주시기 바랍니다.
[로고 사용법 읽기](https://www.zettlr.com/press#usage-rights).

Zettlr

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Zettlr

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README