.i18n/conf.yml

i18n.site 에 대한 구성 파일은 .i18n/conf.yml 이고 내용은 다음과 같습니다 :

i18n:
  fromTo:
    en:
upload:
  ext:
    - md
nav:
  - i18n: home
    use: Toc
    url: /
  - i18n: doc
    menu: NB demo1,demo2
    use: Doc
  - i18n: blog
    use: Blog
addon:
  - i18n.addon/toc

그 중 구성 항목이 upload ~ ext: 이라는 것은 게시할 때 .md 개만 업로드된다는 의미입니다.

상단 탐색 탐색

nav: 구성 옵션, 홈페이지 상단의 탐색 메뉴에 해당합니다.

그 중 i18n: home home: Home in en/i18n.yml 에 해당합니다(여기서 en 프로젝트 번역의 소스 언어입니다).

en/i18n.yml 콘텐츠는 탐색 메뉴에 표시되는 텍스트로, 구성에서 fromTo 에 따라 번역됩니다(예: zh/i18n.yml 로 번역).

번역이 완료된 후 번역 yml 의 값을 수정할 수 있지만 번역 yml 의 키를 추가하거나 삭제하지 마세요.

0개요가 포함된 use: Toc 문서 템플릿

nav :

  - i18n: home
    use: Toc
    url: /

use: Toc 단일 Markdown 템플릿을 렌더링하는 Toc 템플릿을 사용하여 렌더링하는 것을 의미합니다.

TOC Table of Contents 의 약어입니다. 이 템플릿이 렌더링되면 이 Markdown 파일의 개요가 사이드바에 표시됩니다.

url: Markdown 의 파일 경로를 나타냅니다( / 루트 디렉터리 /README.md 에 해당하며 이 파일 이름에는 대문자 접두사와 소문자 접미사가 필요합니다).

0개요가 없는 use: Md 문서 템플릿

Md 템플릿과 Toc 템플릿은 동일하며 둘 다 단일 Markdown 파일을 렌더링하는 데 사용됩니다. 그러나 Md 템플릿은 사이드바에 개요를 표시하지 않습니다.

위 구성의 use: Toc use: Md 로 수정하고, md 디렉터리에서 i18n.site 다시 실행한 후 개발 미리보기 URL을 방문하여 홈페이지에서 변경 사항을 관찰할 수 있습니다.

use: Blog 블로그 템플릿

블로그 템플릿에는 게시 시간 순서대로 기사 목록(제목 및 초록)이 표시됩니다.

→ 특정 구성에 대해 알아보려면 여기를 클릭하세요.

use: Doc 파일 문서 템플릿

구성 파일에서:

  - i18n: doc
    menu: NB demo1,demo2
    use: Doc

템플릿 렌더링에 Doc 사용함을 나타냅니다.

Doc 템플릿은 여러 MarkDown 통합하여 단일 또는 여러 프로젝트에 대한 문서 개요를 생성하는 것을 지원합니다.

여러 프로젝트 및 여러 파일

.i18n/conf.yml in i18n:doc 구성은 다중 프로젝트 다중 파일 렌더링 모드입니다.

여기서 menu: NB demo1,demo2 은 NB 템플릿을 사용하여 드롭다운 메뉴를 렌더링하는 것을 의미합니다.

Name Breif 의 약자인 NB 은 드롭다운 메뉴에 프로젝트의 이름과 슬로건을 표시할 수 있다는 의미입니다.

NB 뒤에는 매개변수 demo1,demo2 전달됩니다.

참고 : ** demo1,demo2 의 쉼표 , 앞뒤에는 ** 이 없어야 합니다.

위 매개변수의 경우 해당 디렉터리 인덱스 파일은 다음과 같습니다.

• en/demo1/TOC
• en/demo2/TOC

단일 프로젝트 다중 파일

프로젝트가 하나만 있는 경우 다음과 같이 구성할 수 있습니다.

  - i18n: doc
    url: flashduty
    use: Doc

[!WARN] 여러 파일이 포함된 단일 프로젝트는 url 루트 경로 / 로 구성하는 것을 지원하지 않습니다. conf.yml → nav: 루트 경로가 구성되어 있지 않으면 해당 웹 사이트의 홈페이지에 액세스할 때 nav: 구성의 첫 번째 URL에 자동으로 다시 작성됩니다. 이 디자인은 디렉토리를 통해 프로젝트 문서, 블로그 및 기타 콘텐츠를 더 잘 구별하기 위한 것입니다. 단일 파일과 단일 페이지를 홈 페이지로 사용하는 것이 좋습니다.

[!TIP] url 쓰지 않으면 url 의 기본값은 i18n 입니다. 이 규칙은 다른 템플릿에도 적용됩니다.

TOC 목차 색인

구성에서 템플릿 use: Doc 활성화된 경우 플러그인 i18n.addon/toc in .i18n/conf.yml 활성화하십시오. 구성은 다음과 같습니다 :

addon:
  - i18n.addon/toc

i18n.site 이 플러그인을 자동으로 설치 및 실행하고, TOC 디렉터리 인덱스 파일을 읽고, json 디렉터리 개요를 생성합니다.

여러 파일이 포함된 단일 프로젝트인 경우 루트 디렉터리 TOC 은 소스 언어 디렉터리의 url: 에 해당하는 디렉터리입니다. 예를 들어 소스 언어가 중국어인 경우: url: flashduty 에 해당하는 파일은 zh/flashduty/TOC 입니다.

여러 프로젝트, 여러 파일인 경우에는 url: 구성할 필요가 없습니다. TOC 의 루트 디렉터리는 i18n 의 값에 해당하는 디렉터리입니다.

자세한 내용 설명

en/blog/TOC 내용은 다음과 같습니다 :

README.md

news/README.md
  news/begin.md

들여쓰기를 사용하여 수준 표시

위 en/blog/TOC 의 첫 번째 행에 있는 README.md 아래 그림의 i18n.site 에 해당하며, 이는 프로젝트 이름입니다.

다음 두 줄은 아래 스크린샷과 같습니다.

news/README.md News 에 해당하고, news/begin.md Our Product is Online ! 에 해당합니다.

TOC 파일은 개요의 계층적 관계를 나타내기 위해 들여쓰기되어 있으며, 다단계 들여쓰기 및 # 로 시작하는 줄 주석을 지원합니다.

상위 수준에서는 내용이 아닌 제목만 작성합니다.

여러 수준의 들여쓰기가 있는 경우 상위 수준에서는 내용이 아닌 제목만 작성합니다. 그렇지 않으면 타이포그래피가 엉망이 될 것입니다.

프로젝트 README.md

내용은 항목 README.md (예: en/demo2/README.md 에 작성할 수 있습니다.

참고로 본 파일의 내용은 목차 개요를 보여주지 않으므로 길이를 제한하고 짧은 소개를 작성하는 것이 좋습니다.

프로젝트 슬로건

Deme Two 에는 드롭다운 메뉴와 카탈로그 개요 프로젝트 이름 Your Project slogan 아래에 프로젝트 태그라인이 있는 것을 볼 수 있습니다 :

이는 en/demo2/README.md 의 첫 번째 행에 해당합니다 :

# Demo Two : Your Project slogan

프로젝트 README.md 의 첫 번째 수준 제목 중 첫 번째 콜론 : 이후의 내용이 프로젝트 슬로건으로 간주됩니다.

중국, 일본, 한국 사용자의 경우 전각 콜론 대신 반각 콜론 : 사용해야 합니다.

TOC를 대량으로 이동하는 방법은 무엇입니까?

TOC 파일은 소스 언어 디렉터리에 있어야 합니다.

예를 들어 소스 언어가 중국어인 경우 위의 TOC 은 zh/blog/TOC 입니다.

소스 언어가 수정된 경우 프로젝트 내 특정 언어의 TOC 개 파일을 다른 언어로 일괄 이동해야 합니다.

다음 명령을 참조할 수 있습니다.

rsync -av --remove-source-files --include='*/' \
--include='TOC' --exclude='*' en/ zh/

위 명령의 en/ 과 zh/ 언어 코드로 수정하세요.

구성 경로 없이 기본 로딩

액세스되는 특정 경로에 대해 경로 접두어가 nav: 에 구성되어 있지 않으면 해당 경로에 해당하는 MarkDown 파일이 기본적으로 로드되고 Md 템플릿을 사용하여 렌더링됩니다.

예를 들어 /test 에 액세스하고 nav: 이 경로의 접두사 없이 구성되고 현재 검색 언어가 영어(코드 en )인 경우 기본적으로 /en/test.md 로드되고 템플릿 Md 사용하여 렌더링됩니다.

/en/test.md 이 파일이 없으면 기본 404 페이지가 표시됩니다.