Skip to content

Commit a797a2f

Browse files
authored
Update README.md
1 parent d2a0835 commit a797a2f

1 file changed

Lines changed: 74 additions & 1 deletion

File tree

README.md

Lines changed: 74 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,75 @@
1-
# MultiLanguageMarkdownGenerator
1+
# CSharp-Multilingual-Markdown-Generator
22
다국어 마크다운 문서 생성기
3+
4+
이 프로젝트는 ryul1206님의 multilingual-markdown 프로젝트를 기반으로 만들어 졌습니다.
5+
6+
[Link : https://github.com/ryul1206/multilingual-markdown ](https://github.com/ryul1206/multilingual-markdown)
7+
8+
9+
## 개요
10+
코드 키워드를 이용해 각 언어별 문서를 생성해줍니다.
11+
12+
13+
## 사용법
14+
### 파일 규칙
15+
{FileName}.base.md 으로 되어 있어야 합니다. 예시는 [example.base.md](example/example.base.md)을 보시면 됩니다
16+
17+
ex : Readme.base.md
18+
19+
### 문서 생성
20+
문서 생성 / Generate 버튼을 이용해 파일을 선택후 만듭니다
21+
22+
23+
### 주 언어 설정
24+
주 언어 / Main Language 의 라디오 버튼을 이용해 주 언어를 설정합니다.
25+
주 언어로 선택된 언어는 파일 이름에서 .base. 가 제거되어서 나옵니다
26+
27+
(ex :Readme.base.md -> Readme.md)
28+
29+
30+
## 코드 키워드
31+
**언어 키워드**
32+
33+
언어별 텍스트 영역을 구분하는 키워드입니다.
34+
언어 키워드를 인식한 후 다음 언어 키워드나 공통 영역 키워드를 만날때가지 해당 언어로 처리됩니다.
35+
36+
아래는 현재 지원하는 언어입니다
37+
```
38+
<!-- [en] -->
39+
<!-- [kr] -->
40+
<!-- [fr] -->
41+
<!-- [jp] -->
42+
```
43+
44+
**공통 영역**
45+
46+
모든 언어에 공통으로 들어갈 텍스트 영역을 구분하는 키워드입니다.
47+
```
48+
<!-- [common] -->
49+
```
50+
51+
52+
**무시 영역**
53+
54+
주석용으로 쓰는 영역입니다. 이 영역에 지정된 텍스트는 파일에 포함되지 않습니다
55+
```
56+
<!-- [ignore] -->
57+
```
58+
59+
60+
**언어 링크 키워드**
61+
62+
이 키워드가 있는 곳는 언어별 문서 링크 텍스트로 대체됩니다. 문서에 포함된 언어를 자동으로 링크해 줍니다
63+
64+
```
65+
<!-- [document_link] -->
66+
```
67+
68+
69+
70+
71+
72+
73+
74+
75+

0 commit comments

Comments
 (0)