1.9.x

Translate

Site Preparation

도큐사우르스 설치하기를 마치고 나면 여러분이 원하는 웹사이트를 만들기 위한 뼈대를 가질 수 있습니다. 아래 내용에서는 여러분의 사이트를 만들 때 참조할 수 있는 도큐사우르스 구조에 대해 설명합니다.

디렉토리 구조

설치된 도큐사우르스 에서 살펴본 것처럼 설치 스크립트를 실행하고 나면 아래와 같은 디렉토리 구조가 생성됩니다.

root-directory
├── .gitignore
├── 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

디렉토리 설명

  • Documentation Source Files: The docs directory contains example documentation files written in Markdown.
  • 블로그: website/blog 디렉토리에는 Markdown으로 작성된 블로그 포스팅 예제들이 있습니다.
  • 페이지: website/pages 디렉토리에는 사이트 메인 페이지 예제 문서가 있습니다.
  • 리소스 파일: website/static 디렉토리에는 예제 사이트에서 사용하는 리소스 파일이 있습니다.

주요 파일

  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
  • .gitignore: The .gitignore file lists the necessary ignore files for the generated site so that they do not get added to the git repo.

주의할 점

You will need to keep the website/siteConfig.js and website/core/Footer.js files, but may edit them as you wish. 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. At the bare minimum you should have an en/index.js or en/index.html file inside website/pages and an image to use as your header icon inside website/static.

If your directory does not yet have a .gitignore, we generate it with the necessary ignored files listed. As a general rule, you should ignore all node_modules, build files, system files (.DS_Store), logs, etc. Here is a more comprehensive list of what is normally ignored for Node.js projects.

← InstallationCreating your site →