Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/en/custom-block.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 🔩 Custom Block Node And HTML Node

The TOAST UI Editor (henceforth referred to as 'Editor') follows the [CommonMark](https://spec.commonmark.org/0.29/) specification, and also supports the [GFM](https://github.github.com/gfm/) specification. But what if you want to use a specific syntax that is not supported by CommonMark or GFM? For example, you might want to use [LaTeX](https://www.latex-project.org/) syntax or render elements such as charts in Markdown. The editor provides the option to define a **custom block node** for this usability.
The TOAST UI Editor (henceforth referred to as 'Editor') follows the [CommonMark](https://spec.commonmark.org/0.31.2/) specification, and also supports the [GFM](https://github.github.com/gfm/) specification. But what if you want to use a specific syntax that is not supported by CommonMark or GFM? For example, you might want to use [LaTeX](https://www.latex-project.org/) syntax or render elements such as charts in Markdown. The editor provides the option to define a **custom block node** for this usability.

## Custom Block Node

Expand Down Expand Up @@ -56,7 +56,7 @@ In WYSIWYG Editor, the custom block node is rendered in the same result as a mar
## HTML Node

CommonMark uses `<` and `>` characters to write nodes that are not supported by default in HTML text.
([CommonMark Raw HTML Spec](https://spec.commonmark.org/0.29/#raw-html))
([CommonMark Raw HTML Spec](https://spec.commonmark.org/0.31.2/#raw-html))

Because Markdown Editor also follows these specifications, HTML text are rendered correctly in the Markdown preview.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/custom-html-renderer.md
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@ function codeBlock(node) {

### Controlling Newlines

In a normal situation, we don't need to care about formatting of converted HTML string. However, as the ToastMark support [CommonMark Spec](https://spec.commonmark.org/0.29/), the renderer supports an option to control new-lines to pass the [official test cases](https://spec.commonmark.org/0.29/spec.json).
In a normal situation, we don't need to care about formatting of converted HTML string. However, as the ToastMark support [CommonMark Spec](https://spec.commonmark.org/0.31.2/), the renderer supports an option to control new-lines to pass the [official test cases](https://spec.commonmark.org/0.31.2/spec.json).

The `outerNewline` and `innerNewline` property can be added to token objects to control white spaces. The following example will help you understand how to use these properties.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/extended-autolinks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### Autolinks

The [Autolinks](https://spec.commonmark.org/0.29/#autolinks) is the CommonMark specification like as below. (If you want to know the detail specification of the Autolinks, refer to examples in the above link.)
The [Autolinks](https://spec.commonmark.org/0.31.2/#autolinks) is the CommonMark specification like as below. (If you want to know the detail specification of the Autolinks, refer to examples in the above link.)
> Autolinks are absolute URIs and email addresses inside `<` and `>`. They are parsed as `>` links, with the URL or email address as the link label.

The functionality is available in TOAST UI Editor (henceforth referred to as 'Editor') without any configuration, because the Editor follows the CommonMark specification.
Expand Down
4 changes: 2 additions & 2 deletions docs/ko/custom-block.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 🔩 커스텀 블록 노드와 HTML 노드

TOAST UI Editor(이하 '에디터'라고 명시)는 [CommonMark](https://spec.commonmark.org/0.29/) 스펙을 준수하며, 추가로 [GFM](https://github.github.com/gfm/) 스펙도 지원한다. 하지만 만약 CommonMark나 GFM에서 지원하지 않는 특정 문법을 사용하고 싶다면 어떨까? 예를 들어 마크다운에서 [LaTeX](https://www.latex-project.org/) 문법을 사용하거나 차트 같은 요소를 렌더링하고 싶을 수 있다. 에디터에서는 이러한 사용성을 위해 사용자만의 **커스텀 블록 노드**를 정의할 수 있는 옵션을 제공한다.
TOAST UI Editor(이하 '에디터'라고 명시)는 [CommonMark](https://spec.commonmark.org/0.31.2/) 스펙을 준수하며, 추가로 [GFM](https://github.github.com/gfm/) 스펙도 지원한다. 하지만 만약 CommonMark나 GFM에서 지원하지 않는 특정 문법을 사용하고 싶다면 어떨까? 예를 들어 마크다운에서 [LaTeX](https://www.latex-project.org/) 문법을 사용하거나 차트 같은 요소를 렌더링하고 싶을 수 있다. 에디터에서는 이러한 사용성을 위해 사용자만의 **커스텀 블록 노드**를 정의할 수 있는 옵션을 제공한다.

## 커스텀 블록 노드

Expand Down Expand Up @@ -55,7 +55,7 @@ $$
## HTML 노드

CommonMark에서는 `<`과 `>` 문자를 사용하여 기본적으로 지원하지 않는 노드를 HTML 문자열 형태로 작성할 수 있다.
([CommonMark Raw HTML Spec 참조](https://spec.commonmark.org/0.29/#raw-html))
([CommonMark Raw HTML Spec 참조](https://spec.commonmark.org/0.31.2/#raw-html))

에디터의 마크다운 에디터에서도 이러한 스펙을 준수하기 때문에 HTML 문자열은 마크다운 프리뷰에서 올바르게 렌더링 된다.

Expand Down
2 changes: 1 addition & 1 deletion docs/ko/custom-html-renderer.md
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,7 @@ function codeBlock(node) {

### 개행 추가

일반적인 경우 최종적으로 변환된 HTML 문자열의 포맷에 신경 쓸 필요가 없다. 그러나 `ToastMark`는 [CommonMark Spec](https://spec.commonmark.org/0.29/)을 준수하기 때문에 개행을 제어하는 옵션을 지원해야만 한다.([공식 테스트 데이터](https://spec.commonmark.org/0.29/spec.json))
일반적인 경우 최종적으로 변환된 HTML 문자열의 포맷에 신경 쓸 필요가 없다. 그러나 `ToastMark`는 [CommonMark Spec](https://spec.commonmark.org/0.31.2/)을 준수하기 때문에 개행을 제어하는 옵션을 지원해야만 한다.([공식 테스트 데이터](https://spec.commonmark.org/0.31.2/spec.json))

컨버팅 함수의 토큰 객체에 `outerNewline`과 `innerNewline` 프로퍼티를 추가하여 개행을 제어할 수 있다.

Expand Down
2 changes: 1 addition & 1 deletion docs/ko/extended-autolinks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## 자동 링크란 무엇일까?

[자동 링크](https://spec.commonmark.org/0.29/#autolinks)는 CommonMark에 정의된 스펙이다. (자동 링크의 세부 사양을 알고 싶으면 위 링크의 예를 참조바란다.)
[자동 링크](https://spec.commonmark.org/0.31.2/#autolinks)는 CommonMark에 정의된 스펙이다. (자동 링크의 세부 사양을 알고 싶으면 위 링크의 예를 참조바란다.)

자동 링크는 `<`, `>` 사이에 위치한 절대 경로 URI 또는 이메일 주소이다. URL 또는 이메일 주소를 링크 레이블로 하여 구문 분석된다.

Expand Down
2 changes: 1 addition & 1 deletion libs/toastmark/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ ToastMark is a markdown parser extended from [commonmark.js](https://github.com/
## Differences from commonmark.js

### GitHub Flavored Markdown(GFM) Support
commonmark.js is the reference implementation of [CommonMark](https://spec.commonmark.org/0.29/) and doesn't support [GFM](https://github.github.com/gfm/), which is extended markdown syntax based on CommonMark. ToastMark has its own implementation for supporting GFM.
commonmark.js is the reference implementation of [CommonMark](https://spec.commonmark.org/0.31.2/) and doesn't support [GFM](https://github.github.com/gfm/), which is extended markdown syntax based on CommonMark. ToastMark has its own implementation for supporting GFM.

### Source Position Information
Although commonmark.js provides source position information related with each node in AST(Abstract Syntax Tree), those are limited to block-level elements. ToastMark extended this feature to provide source position information for inline-level elements also.
Expand Down
Loading