ReLaXed - GitLite

KO | EN

gitlite — search

#python #react #ai #go #golang #machine-learning #deep-learning #macos #java #awesome #kubernetes #ios #openai #open-source

ReLaXed

(★ 11,799)

웹 기술을 사용하여 PDF 문서 생성하기

파일 탐색기

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

- - npmpublish.yml
- plugin_hooks.png
- relaxed_stack.png
- - index.js
- - pdf2gif.js
  - pretty-pdf-thumbnail.js
- index.js
- masterToPDF.js
- parseLocals.js
- plugins.js
- test.js
.gitignore
.npmignore
.travis.yml
changelog.md
LICENCE.txt
logo-blue.png
package.json
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/RelaxedJS/ReLaXed

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd ReLaXed

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. 공식 설치 스크립트

쉬움 추천

사전 준비물

Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다.

npm i -g relaxedjs

npm 레지스트리에 배포된 패키지를 전역으로 설치합니다. 소스 클론이 필요 없습니다.

✅ 설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Node.js

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm i -g relaxedjs

npm 레지스트리에 배포된 패키지를 전역으로 설치합니다. 소스 클론이 필요 없습니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![](https://github.com/RelaxedJS/ReLaXed/raw/master/logo-blue.png)

# ReLaXed
[![Build Status](https://travis-ci.org/RelaxedJS/ReLaXed.svg?branch=master)](https://travis-ci.org/RelaxedJS/ReLaXed)
ReLaXed는 HTML 또는 HTML의 약어인 [Pug](https://pugjs.org/api/getting-started.html)를 사용하여 인터랙티브하게 PDF 문서를 생성합니다. Markdown이나 LaTeX에 가까운 친숙하고 미니멀한 구문으로 콘텐츠를 작성하는 동시에, CSS와 JavaScript로 복잡한 레이아웃을 정의할 수 있습니다.
Atom 에디터에서 작동하는 모습은 다음과 같습니다:

![](https://i.imgur.com/4N4fSYY.gif "source: imgur.com")

다음은 몇 가지 출력 예시입니다:

|  |  |  |  |
| --- | --- | --- | --- |
| 책 - [소스](https://github.com/RelaxedJS/ReLaXed-examples/tree/master/examples/book/) / [PDF](https://github.com/RelaxedJS/ReLaXed-examples/blob/master/examples/book/book.pdf) | 편지 - [소스](https://github.com/RelaxedJS/ReLaXed-examples/tree/master/examples/letter/) / [PDF](https://github.com/RelaxedJS/ReLaXed-examples/blob/master/examples/letter/letter.pdf) | 이력서 - [소스](https://github.com/RelaxedJS/ReLaXed-examples/tree/master/examples/resume/) / [PDF](https://github.com/RelaxedJS/ReLaXed-examples/blob/master/examples/resume/resume.pdf) | 명함 - [소스](https://github.com/RelaxedJS/ReLaXed-examples/tree/master/examples/business-card/) / [PDF](https://github.com/RelaxedJS/ReLaXed-examples/blob/master/examples/business-card/business-card.pdf) |

|  |  |  |  |
| --- | --- | --- | --- |
| 슬라이드 - [소스](https://github.com/RelaxedJS/ReLaXed-examples/tree/master/examples/slides/) / [PDF](https://github.com/RelaxedJS/ReLaXed-examples/blob/master/examples/slides/slides.pdf) | 보고서 - [소스](https://github.com/RelaxedJS/ReLaXed-examples/tree/master/examples/report/) / [PDF](https://github.com/RelaxedJS/ReLaXed-examples/blob/master/examples/report/report.pdf) | 논문 - [소스](https://github.com/RelaxedJS/ReLaXed-examples/tree/master/examples/paper/) / [PDF](https://github.com/RelaxedJS/ReLaXed-examples/blob/master/examples/paper/paper.pdf) | 포스터 - [소스](https://github.com/RelaxedJS/ReLaXed-examples/tree/master/examples/poster/) / [PDF](https://github.com/RelaxedJS/ReLaXed-examples/blob/master/examples/poster/poster.pdf) |

ReLaXed는 Markdown, LaTeX 스타일의 수식([MathJax](https://www.mathjax.org/) 사용), CSV의 HTML 테이블 변환, 그래프 생성([Vega-Lite](https://vega.github.io/vega-lite/) 또는 [Chart.js](https://www.chartjs.org/) 사용), 그리고 다이어그램 생성([mermaid](https://mermaidjs.github.io/) 사용)을 지원합니다. 기존 JavaScript나 CSS 프레임워크를 가져오는 것만으로도 훨씬 더 많은 기능을 추가할 수 있습니다.

## ReLaXed 설치하기
다음 명령어로 [NPM](https://www.npmjs.com/)을 통해 ReLaXed를 설치하세요(``sudo``는 사용하지 마세요):

```
npm i -g relaxedjs
```

이렇게 하면 시스템에서 ``relaxed`` 명령어를 사용할 수 있게 됩니다. 설치가 실패하면 [문제 해결 페이지](https://github.com/RelaxedJS/ReLaXed/wiki/Troubleshooting)를 참고하세요. Docker를 통해 ReLaXed를 사용할 수도 있습니다([이 저장소](https://github.com/jonathanasquier/ReLaXed-docker/blob/master/Dockerfile) 참조).

## 시작하기
프로젝트를 시작하려면, 다음과 같은 Pug 내용으로 새 문서 ``my\_document.pug``를 만드세요:

```pug
h1 My document's title
p A paragraph in my document
```

그런 다음 터미널에서 ReLaXed를 시작합니다:

```
relaxed my\_document.pug
```

ReLaXed는 ``my\_document.pug``로부터 ``my\_document.pdf``를 생성한 다음, 디렉토리와 하위 디렉토리를 모니터링하여 파일이 변경될 때마다 ``my\_document.pdf``를 다시 생성합니다.

파일을 계속 모니터링하지 않고 PDF 파일을 단 한 번만 생성하려면 다음 명령어를 사용할 수 있습니다:

```
relaxed my\_document.pug --build-once
```

더 알아보려면:
- ``relaxed`` 명령어의 [사용법 및 옵션](https://github.com/RelaxedJS/ReLaXed/wiki/Command-line-options)에 대해 자세히 읽어보세요.
- [Pug 언어](https://pugjs.org/api/getting-started.html)의 기능에 대해 자세히 알아보세요.
- [ReLaXed 플러그인](https://github.com/RelaxedJS/ReLaXed/wiki/Plugins)을 사용하거나 작성하는 방법을 알아보세요.
- [예제들](https://github.com/RelaxedJS/ReLaXed-examples)을 둘러보세요.
- ReLaXed 사용을 위한 [권장 설정](https://github.com/RelaxedJS/ReLaXed/wiki/Tips-and-recommendations)을 읽어보세요.
- ReLaXed의 [특수 파일 렌더링](https://github.com/RelaxedJS/ReLaXed/wiki/Special-file-renderings)에 대해 읽어보세요.
- ReLaXed와 다른 문서 편집 시스템 간의 [비교 내용](https://github.com/RelaxedJS/ReLaXed/wiki/ReLaXed-vs-other-solutions)을 읽어보세요.

## 왜 또 다른 PDF 문서 생성기인가요?
우리 중 많은 사람은 MS Office나 Google Docs 같은 GUI 문서 편집기보다 마크업 언어(Markdown, LaTeX 등)를 선호합니다. 마크업 언어를 사용하면 일관된 스타일의 문서를 더 빠르고 쉽게 작성할 수 있기 때문입니다.

하지만 Markdown은 제목/섹션/단락 구조로 제한되어 있고, LaTeX는 이해하기 어려운 구자와 오류가 있어 익숙한 방식에서 벗어나기가 어렵습니다.

반면, 웹 기술은 그 어느 때보다 훌륭해졌습니다.
- 아름다운 CSS 프레임워크를 통해 문서를 깔끔하고 현대적으로 보이게 할 수 있습니다.
- 거의 모든 용도에 맞는 JavaScript 라이브러리가 존재합니다: 그래프 작성, 코드 하이라이팅, 수식 렌더링 등...
- 수백만 명(그리고 계속 증가하는 추세)의 사용자가 이를 다룰 줄 압니다.
- Pug와 SCSS 같은 축약 언어 덕분에 이제 HTML과 CSS를 재미있게 작성할 수 있습니다.
- (헤드리스) 웹 브라우저는 어떤 플랫폼에서든 웹 문서를 PDF로 쉽게 변환할 수 있습니다.

ReLaXed는 데스크톱에서 PDF를 생성할 때 이러한 기술들을 활용할 수 있는 가장 편안한 방법을 찾기 위한 시도입니다.

## ReLaXed의 작동 방식
ReLaXed는 다른 소프트웨어들을 결합하는 몇 줄의 코드로 이루어져 있습니다. 파일 시스템을 모니터링하기 위해 [Chokidar](https://github.com/paulmillr/chokidar)를 사용합니다. 파일이 변경되면 여러 JavaScript 라이브러리를 사용하여 SCSS, Pug, Markdown 및 다이어그램 파일(mermaid, flowchart.js, Chart.js)을 HTML 페이지로 컴파일한 다음, 헤드리스 Chromium 인스턴스([Puppeteer](https://github.com/GoogleChrome/puppeteer) 사용)를 통해 PDF 파일로 인쇄합니다.

![](https://github.com/RelaxedJS/ReLaXed/raw/master/docs/relaxed_stack.png)

## Node 모듈로 사용하기
\*\*MasterToPDF.js\*\*는 기본적으로 메인 패키지로 노출되어 있어 직접 사용할 수 있습니다.
예시:
```javascript
const { masterToPDF } = require('relaxedjs');
const puppeteer = require('puppeteer');
const plugins = require('relaxedjs/src/plugins');
const path = require('path');
class HTML2PDF {
constructor() {
this.puppeteerConfig = {
headless: true,
args: [
'--no-sandbox',
'--disable-translate',
'--disable-extensions',
'--disable-sync',
],
};
this.relaxedGlobals = {
busy: false,
config: {},
configPlugins: [],
};
this.\_initializedPlugins = false;
}
async \_initializePlugins() {
if (this.\_initializedPlugins) return; // Do not initialize plugins twice
for (const [i, plugin] of plugins.builtinDefaultPlugins.entries()) {
plugins.builtinDefaultPlugins[i] = await plugin.constructor();
}
await plugins.updateRegisteredPlugins(this.relaxedGlobals, '/');
const chrome = await puppeteer.launch(this.puppeteerConfig);
this.relaxedGlobals.puppeteerPage = await chrome.newPage();
this.\_initializedPlugins = true;
}
async pdf(templatePath, json\_data, tempHtmlPath, outputPdfPath) {
await this.\_initializePlugins();
if (this.\_initializedPlugins) {
// Paths must be absolute
const defaultTempHtmlPath = tempHtmlPath || path.resolve('temp.html');
const defaultOutputPdfPath =
outputPdfPath || path.resolve('output.pdf');
await masterToPDF(
templatePath,
this.relaxedGlobals,
defaultTempHtmlPath,
defaultOutputPdfPath,
json\_data
);
}
}
}
module.exports = new HTML2PDF();
```
사용법:
```javascript
const HTML2PDF = require('./HTML2PDF.js');
(async () => {
await HTML2PDF.pdf('./template.pug', {"a":"b", "c":"d"});
})();
```
## 기여하기!
ReLaXed는 원래 [Zulko](https://github.com/Zulko)가 작성하고 ISC 라이선스로 [Github](https://github.com/RelaxedJS/ReLaXed)에 공개한 오픈소스 프레임워크입니다. 누구나 기여할 수 있습니다!
버그 신고 및 기능 요청은 Github 이슈를 열어주세요. 지원이나 Pug/HTML 관련 질문은 Stackoverflow나 모든 종류의 토론에 사용할 수 있는 새로운 [reddit/r/relaxedjs](https://www.reddit.com/r/relaxedjs/) 포럼에 문의해 주세요.
\*\*프로젝트 멤버:\*\*
- [@Zulko](https://github.com/Zulko) (소유자)
- [@Drew-S](https://github.com/Drew-S) (아키텍처, 플러그인)
- [@DanielRuf](https://github.com/DanielRuf)
- [@benperiton](https://github.com/benperiton)
## 라이선스
[ISC](https://github.com/RelaxedJS/ReLaXed/blob/master/LICENCE.txt)