Skip to content

Commit 4f0bf9c

Browse files
committed
docs: rename textlint-guide.md and related links accordingly
`textlint-guide.md`로 파일 이름 변경 및 관련 링크 수정.
1 parent acff8ac commit 4f0bf9c

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ If your PR references an existing issue, please add the issue number below
1616
- [ ] [공통 스타일 가이드 확인 (Check the common style guide)](https://github.com/reactjs/ko.react.dev/blob/main/wiki/universal-style-guide.md)
1717
- [ ] [모범 사례 확인 (Check best practices)](https://github.com/reactjs/ko.react.dev/blob/main/wiki/best-practices-for-translation.md)
1818
- [ ] [용어 확인 (Check the term)](https://github.com/reactjs/ko.react.dev/blob/main/wiki/translate-glossary.md)
19-
- [ ] [Textlint 가이드 확인 (Check the textlint guide)](https://github.com/reactjs/ko.react.dev/blob/main/wiki/textlint/what-is-textlint.md)
19+
- [ ] [Textlint 가이드 확인 (Check the textlint guide)](https://github.com/reactjs/ko.react.dev/blob/main/wiki/textlint-guide.md)
2020
- [ ] [맞춤법 검사 (Spelling check)](https://nara-speller.co.kr/speller/)
2121
- [ ] 리뷰 반영 (Resolve reviews)

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
1. [공통 스타일 가이드<sup>Universal Style Guide</sup>](/wiki/universal-style-guide.md)를 확인해주세요.
1313
1. [번역을 위한 모범 사례<sup>Best Practices for Translation</sup>](/wiki/best-practices-for-translation.md)를 따라주세요.
1414
1. 공통된 단어 번역을 위해 [번역 용어 정리<sup>Translate Glossary</sup>](/wiki/translate-glossary.md)를 참고해주세요.
15-
1. 끌어오기 요청<sup>Pull Request</sup>시 테스트를 통과하지 못할 경우, [`textlint` 가이드<sup>What is Textlint</sup>](/wiki/textlint/what-is-textlint.md)를 참고해주세요.
15+
1. 끌어오기 요청<sup>Pull Request</sup>시 테스트를 통과하지 못할 경우, [`textlint` 가이드<sup>Textlint Guide</sup>](/wiki/textlint-guide.md)를 참고해주세요.
1616
1. 마지막으로 [맞춤법 검사<sup>Spelling Check</sup>](https://nara-speller.co.kr/speller/)를 진행해주세요.
1717

1818
이 저장소<sup>Repository</sup>는 [ko.react.dev](https://ko.react.dev/)의 소스 코드와 개발 문서를 포함하고 있습니다.

wiki/textlint/what-is-textlint.md renamed to wiki/textlint-guide.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# `textlint` for ko.react.dev
1+
# `textlint` 가이드
22

3-
React 공식 페이지 한국어 번역 시 활용하는 [`textlint`](https://textlint.github.io/)에 대해 설명합니다.
3+
React 공식 문서 한국어 번역 시 활용하는 [`textlint`](https://textlint.github.io/)에 대해 설명합니다.
44

55
## 무엇인가요?
66

@@ -23,11 +23,11 @@ ko.react.dev/src/content/blog/2023/03/16/introducing-react-dev.md:60:35
2323
^
2424
```
2525

26-
`textlint`는 텍스트(`.txt`)와 마크다운(`.md`, `.mdx`)을 위한 Linter이며 JavaScript로 구현되어 있습니다. [ESLint](https://eslint.org/)JavaScript에 가지는 역할과 같습니다.
26+
`textlint`는 텍스트(`.txt`)와 마크다운(`.md`, `.mdx`)을 위한 린터<sup>Linter</sup>이며 자바스크립트<sup>JavaScript</sup>로 구현되어 있습니다. [ESLint](https://eslint.org/)자바스크립트에 가지는 역할과 같습니다.
2727

2828
## 어떻게 실행할 수 있나요?
2929

30-
[`package.json`](/package.json)상에 `scripts`로 등록해 두었기에, 아래와 같은 커맨드로 실행할 수 있습니다.
30+
[`package.json`](/package.json) 상에 `scripts`로 등록해 두었기에, 아래와 같은 커맨드로 실행할 수 있습니다.
3131

3232
### 1. 규칙 검사
3333

@@ -57,7 +57,7 @@ yarn textlint-docs
5757

5858
> [!NOTE]
5959
>
60-
> - `textlint`는 마크다운 문서를 AST Tree로 파싱(Parsing) 합니다. ko.react.dev에서 구현한 규칙은 `@textlint/text-to-ast-14.0.5` 패키지에 의해 AST Tree로 파싱 된 노드(Node)들 중 `Str` 노드만을 검사합니다. ([`/textlint/rules/translateGlossary.js` 참고](/textlint/rules/translateGlossary.js))
60+
> - `textlint`는 마크다운 문서를 AST Tree로 파싱<sup>Parsing</sup> 합니다. ko.react.dev에서 구현한 규칙은 `@textlint/text-to-ast-14.0.5` 패키지에 의해 AST Tree로 파싱 된 노드<sup>Node</sup>들 중 `Str` 노드만을 검사합니다. ([`/textlint/rules/translateGlossary.js` 참고](/textlint/rules/translateGlossary.js))
6161
>
6262
> - 또한, 모든 `Str` 노드를 검사하는 것은 아닙니다. 영어 원문 번역본이 계속해서 추가되기에, 오직 영어만으로 구성된 `Str` 노드는 검사에서 제외합니다. 즉, 파싱된 `Str` 노드 중 한글이 하나라도 포함된 문장만을 검사합니다. ([`/textlint/utils/is.js` 참고](/textlint/utils/is.js))
6363
>
@@ -66,7 +66,7 @@ yarn textlint-docs
6666
#### 1. 코드 블럭
6767

6868
````md
69-
```javascript
69+
```js
7070
const hello = 'world';
7171
```
7272
````

0 commit comments

Comments
 (0)