turndown - GitLite

KO | EN

gitlite — search

#javascript #python #react #typescript #llm #golang #android #rust #deep-learning #linux #cli #kubernetes #mcp #openai

turndown

(★ 11,396)

🛏 JavaScript로 작성된 HTML to Markdown 변환기

파일 탐색기

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

- - test.yml
- rollup.config.browser.cjs.mjs
- rollup.config.browser.es.mjs
- rollup.config.browser.umd.mjs
- rollup.config.cjs.mjs
- rollup.config.es.mjs
- rollup.config.iife.mjs
- rollup.config.mjs
- rollup.config.test.mjs
- rollup.config.umd.mjs
- collapse-whitespace.js
- commonmark-rules.js
- html-parser.js
- node.js
- root-node.js
- rules.js
- turndown.js
- utilities.js
- index.html
- internals-test.js
- turndown-test.js
.gitignore
.tm_properties
index.html
LICENSE
package-lock.json
package.json
README.md
SECURITY.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/mixmark-io/turndown

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

cd turndown

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

2. Node.js

쉬움 추천

사전 준비물

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

npm install turndown

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

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

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Turndown
JavaScript를 사용하여 HTML을 Markdown으로 변환합니다.
[온라인](https://mixmark-io.github.io/turndown/)에서 직접 확인해 보세요.

## Project Updates
\* `to-markdown`의 이름이 Turndown으로 변경되었습니다. 자세한 내용은 [마이그레이션 가이드](https://github.com/domchristie/to-markdown/wiki/Migrating-from-to-markdown-to-Turndown)를 참조하세요.
\* Turndown 리포지토리 URL이 https://github.com/mixmark-io/turndown으로 변경되었습니다.

## Installation
npm:
```
npm install turndown
```

Browser:
```html
```

RequireJS와 함께 사용하는 경우, UMD 버전은 `lib/turndown.umd.js`(Node.js용) 및 브라우저용 `lib/turndown.browser.umd.js`에 있습니다. 이 파일들은 npm 패키지가 배포될 때 생성됩니다. 수동으로 생성하려면 이 리포지토리를 복제(`clone`)한 후 `npm run build`를 실행하세요.

## Usage
```js
// For Node.js
var TurndownService = require('turndown')
var turndownService = new TurndownService()
var markdown = turndownService.turndown('

# Hello world!

')
```

Turndown은 입력값으로 DOM 노드(요소 노드, 문서 노드, 또는 문서 조각 노드)도 허용합니다:
```js
var markdown = turndownService.turndown(document.getElementById('content'))
```

## Options
옵션은 인스턴스화할 때 생성자에 전달할 수 있습니다. 예시:
```js
var turndownService = new TurndownService({ option: 'value' })
```

| Option | Valid values | Default |
| :-------------------- | :------------ | :------ |
| `headingStyle` | `setext` 또는 `atx` | `setext` |
| `hr` | 임의의 [Thematic break](http://spec.commonmark.org/0.27/#thematic-breaks) | `\* \* \*` |
| `bulletListMarker` | `-`, `+`, 또는 `\*` | `\*` |
| `codeBlockStyle` | `indented` 또는 `fenced` | `indented` |
| `fence` | ` ``` ` 또는 `~~~` | ` ``` ` |
| `emDelimiter` | `\_` 또는 `\*` | `\_` |
| `strongDelimiter` | `\*\*` 또는 `\_\_` | `\*\*` |
| `linkStyle` | `inlined` 또는 `referenced` | `inlined` |
| `linkReferenceStyle` | `full`, `collapsed`, 또는 `shortcut` | `full` |
| `preformattedCode` | `false` 또는 [`true`](https://github.com/lucthev/collapse-whitespace/issues/16) | `false` |

### Advanced Options
| Option | Valid values | Default |
| :-------------------- | :------------ | :------ |
| `blankReplacement` | 규칙 대체 함수 | 아래의 \*\*Special Rules\*\* 참조 |
| `keepReplacement` | 규칙 대체 함수 | 아래의 \*\*Special Rules\*\* 참조 |
| `defaultReplacement` | 규칙 대체 함수 | 아래의 \*\*Special Rules\*\* 참조 |

## Methods
### `addRule(key, rule)`
`key` 매개변수는 쉽게 참조할 수 있도록 규칙에 지정하는 고유한 이름입니다. 예시:
```js
turndownService.addRule('strikethrough', {
filter: ['del', 's', 'strike'],
replacement: function (content) {
return '~' + content + '~'
}
})
```

`addRule`은 체이닝을 위해 `TurndownService` 인스턴스를 반환합니다.
아래의 \*\*Extending with Rules\*\*를 참조하세요.

### `keep(filter)`
유지하여 HTML로 렌더링할 요소를 결정합니다. 기본적으로 Turndown은 어떤 요소도 유지하지 않습니다. filter 매개변수는 규칙 필터처럼 작동합니다(아래의 필터 섹션 참조). 예시:
```js
turndownService.keep(['del', 'ins'])
turndownService.turndown('

Hello ~~world~~World

') // 'Hello ~~world~~World'
```

이렇게 하면 변환 시 `~~` 및 `` 요소가 HTML로 렌더링됩니다.
`keep`은 여러 번 호출할 수 있으며, 새로 추가된 유지 필터가 이전 필터보다 우선시됩니다. 유지 필터는 표준 CommonMark 규칙 및 추가된 모든 규칙에 의해 재정의됩니다. 이러한 규칙에 의해 일반적으로 처리되는 요소를 유지하려면 원하는 동작을 하는 규칙을 추가하세요.
`keep`은 체이닝을 위해 `TurndownService` 인스턴스를 반환합니다.

### `remove(filter)`
완전히 제거할 요소(즉, 빈 문자열로 변환할 요소)를 결정합니다. 기본적으로 Turndown은 어떤 요소도 제거하지 않습니다. filter 매개변수는 규칙 필터처럼 작동합니다(아래의 필터 섹션 참조). 예시:
```js
turndownService.remove('del')
turndownService.turndown('

Hello ~~world~~World

') // 'Hello World'
```
이렇게 하면 `~~` 요소(및 내용)가 제거됩니다.
`remove`는 여러 번 호출할 수 있으며, 새로 추가된 제거 필터가 이전 필터보다 우선 적용됩니다. 제거 필터는 유지 필터, 표준 CommonMark 규칙 및 추가된 규칙에 의해 재정의됩니다. 이러한 규칙에 의해 일반적으로 처리되는 요소를 제거하려면 원하는 동작을 가진 규칙을 추가하세요.
`remove`는 체이닝을 위해 `TurndownService` 인스턴스를 반환합니다.
### `use(plugin|array)`
플러그인 또는 플러그인 배열을 사용합니다. 예시:
```js
// turndown-plugin-gfm에서 플러그인 가져오기
var turndownPluginGfm = require('turndown-plugin-gfm')
var gfm = turndownPluginGfm.gfm
var tables = turndownPluginGfm.tables
var strikethrough = turndownPluginGfm.strikethrough
// gfm 플러그인 사용
turndownService.use(gfm)
// table 및 strikethrough 플러그인만 사용
turndownService.use([tables, strikethrough])
```
`use`는 체이닝을 위해 `TurndownService` 인스턴스를 반환합니다.
아래의 \*\*Plugins\*\*를참조하세요.
## 규칙으로 확장하기
Turndown은 \*\*rules\*\*를 추가하여 확장할 수 있습니다. 규칙은 `filter` 및 `replacement` 속성을 가진 일반 JavaScript 객체입니다. 예를 들어, `

` 요소를 변환하는 규칙은 다음과 같습니다.
```js
{
filter: 'p',
replacement: function (content) {
return '\n\n' + content + '\n\n'
}
}
```
필터는 `

` 요소를 선택하고, 대체 함수는 두 개의 줄바꿈으로 구분된 `

` 내용을 반환합니다.
### `filter` String|Array|Function
filter 속성은 요소가 규칙의 `replacement`로 대체되어야 하는지 여부를 결정합니다. DOM 노드는 태그 이름이나 태그 이름 배열을 사용하여 간단히 선택할 수 있습니다.
\* `filter: 'p'`는 다음을 선택합니다.

` elements
\* `filter: ['em', 'i']`는 `*` 또는 `*` 요소를 선택합니다.
`filter` 속성의 태그 이름은 문서 내의 형식과 관계없이 소문자로 작성해야 합니다.
또는, 주어진 노드를 교체해야 할지 여부에 따라 불리언(boolean) 값을 반환하는 함수를 필터로 사용할 수 있습니다. 이 함수에는 DOM 노드와 `TurndownService` 옵션이 전달됩니다. 예를 들어, 다음 규칙은 `linkStyle` 옵션이 `inlined`일 때 ( `href`가 있는) `` 요소를 선택합니다:
```js
filter: function (node, options) {
return (
options.linkStyle === 'inlined' &&
node.nodeName === 'A' &&
node.getAttribute('href')
)
}
```
### `replacement` 함수
replacement 함수는 요소가 어떻게 변환되어야 하는지를 결정합니다. 주어진 노드에 대한 마크다운 문자열을 반환해야 합니다. 이 함수에는 노드의 콘텐츠, 노드 자체, 그리고 `TurndownService` 옵션이 전달됩니다.
다음 규칙은 `*` 요소가 어떻게 변환되는지 보여줍니다:
```js
rules.emphasis = {
filter: ['em', 'i'],
replacement: function (content, node, options) {
return options.emDelimiter + content + options.emDelimiter
}
}
```
### 특수 규칙
\*\*Blank rule(공백 규칙)\*\*은 공백 요소를 처리하는 방법을 결정합니다. 이 규칙은 모든 규칙( `addRule`을 통해 추가된 규칙 포함)보다 우선합니다. 노드가 공백만 포함하고 있고, ``, ` `, ` ` 또는 빈(void) 요소가 아닌 경우 공백으로 간주됩니다. 이 동작은 `blankReplacement` 옵션을 사용하여 사용자 정의할 수 있습니다. \*\*Keep rules(유지 규칙)\*\*는 변환하지 않아야 할 요소, 즉 마크다운 출력에서 HTML로 렌더링해야 할 요소를 처리하는 방법을 결정합니다. 기본적으로 유지되는 요소는 없습니다. 블록 레벨 요소는 주변 콘텐츠와 빈 줄로 구분됩니다. 이 동작은 `keepReplacement` 옵션을 사용하여 사용자 정의할 수 있습니다. \*\*Remove rules(제거 규칙)\*\*는 완전히 제거할 요소를 결정합니다. 기본적으로 제거되는 요소는 없습니다. \*\*Default rule(기본 규칙)\*\*은 다른 규칙에서 인식하지 않는 노드를 처리합니다. 기본적으로 노드의 텍스트 콘텐츠를 출력합니다(블록 레벨 요소인 경우 빈 줄로 구분됨). 이 동작은 `defaultReplacement` 옵션으로 사용자 정의할 수 있습니다. ### 규칙 우선순위 Turndown은 규칙 집합을 순회하며 `filter`와 일치하는 첫 번째 규칙을 선택합니다. 다음 목록은 우선순위 순서를 설명합니다: 1. 공백 규칙 2. 추가된 규칙 (선택 사항) 3. Commonmark 규칙 4. 유지 규칙 5. 제거 규칙 6. 기본 규칙 ## 플러그인 플러그인 API는 개발자가 여러 확장을 쉽게 적용할 수 있는 방법을 제공합니다. 플러그인은 `TurndownService` 인스턴스를 인수로 호출되는 함수일 뿐입니다. ## 마크다운 문자 이스케이프 Turndown은 HTML 입력의 마크다운 문자를 이스케이프하기 위해 백슬래시( `\`)를 사용합니다. 이는 출력이 다시 HTML로 컴파일될 때 이러한 문자가 마크다운으로 해석되지 않도록 보장합니다. 예를 들어, `1. Hello world`의 내용은 `1\. Hello world`로 이스케이프되어야 하며, 그렇지 않으면 제목이 아니라 목록 항목으로 해석됩니다. 모든 HTML 요소의 내용을 마크다운으로 파싱하는 것의 복잡성과 성능 저하를 피하기 위해, Turndown은 잠재적인 마크다운 구문을 이스케이프하기 위해 정규 표현식 그룹을 사용합니다. 결과적으로 이스케이프 규칙이 다소 공격적일 수 있습니다. ### `TurndownService.prototype.escape` 오버라이드하기 원한다면 필요에 맞게 이스케이프 동작을 사용자 정의할 수 있습니다. 이는 `TurndownService.prototype.escape`를 오버라이드하여 수행할 수 있습니다. `escape`는 각 HTML 요소의 텍스트를 인수로 받아 마크다운 문자가 이스케이프된 버전을 반환해야 합니다. 참고: 코드 요소 내부의 텍스트는 `escape`에 전달되지 않습니다. ## 라이선스 turndown은 copyright © 2017+ Dom Christie이며 MIT 라이선스에 따라 배포됩니다. | |***~~~~