Site Preparation
도큐사우르스 설치하기를 마치고 나면 여러분이 원하는 웹사이트를 만들기 위한 뼈대를 가질 수 있습니다. 아래 내용에서는 여러분의 사이트를 만들 때 참조할 수 있는 도큐사우르스 구조에 대해 설명합니다.
디렉토리 구조
설치된 도큐사우르스 에서 살펴본 것처럼 설치 스크립트를 실행하고 나면 아래와 같은 디렉토리 구조가 생성됩니다.
root-directory
├── docs
│ ├── doc1.md
│ ├── doc2.md
│ ├── doc3.md
│ ├── exampledoc4.md
│ └── exampledoc5.md
└── website
├── blog
│ ├── 2016-03-11-blog-post.md
│ ├── 2017-04-10-blog-post-two.md
│ ├── 2017-09-25-testing-rss.md
│ ├── 2017-09-26-adding-rss.md
│ └── 2017-10-24-new-version-1.0.0.md
├── core
│ └── Footer.js
├── package.json
├── pages
├── sidebars.json
├── siteConfig.js
└── static
디렉토리 설명
- 문서 소스 파일:
docs
디렉토리에는 Markdown으로 작성된 예제 문서 파일들이 있습니다. - 블로그:
website/blog
디렉토리에는 Markdown으로 작성된 블로그 포스팅 예제들이 있습니다. - 페이지:
website/pages
디렉토리에는 사이트 메인 페이지 예제 문서가 있습니다. - 리소스 파일:
website/static
디렉토리에는 예제 사이트에서 사용하는 리소스 파일이 있습니다.
주요 파일
- 푸터:
website/core/Footer.js
파일은 도큐사우르스로 만드는 사이트의 푸터로 동작하는 리액트 컴포넌트입니다. 만들고자하는 사이트에 맞게 내용은 수정되어야 합니다. - 설정 파일:
website/siteConfig.js
파일은 도큐사우르스에서 사용하는 설정 파일입니다. - 사이드바:
sidebars.json
파일은 문서 파일들의 순서와 구조를 담고 있습니다.
주의할 점
당신은 website/siteConfig.js
와 website/core/Footer.js
파일들을 그대로 유지해도 되지만, 필요하다면 원하는대로 수정할 수도 있습니다. The value of the customDocsPath
key in website/siteConfig.js
can be modified if you wish to use a different directory name or path. The website
directory can also be renamed to anything you want it to be.
However, you should keep the website/pages
and website/static
directories. You may change the content inside them as you wish. 최소한 website/pages
안에 en/index.js
또는 en/index.html
파일은 가지고 있어야 하며, 헤더 아이콘으로 사용할 이미지는 website/static
안에 있어야 합니다.