1.10.x

Translate

Creating your site

도큐사우르스는 최대한 간단하게 여러분의 오픈소스 프로젝트를 위한 사이트와 문서를 만들 수 있도록 설계됐습니다.

설치하기와 준비하기 단계를 지나왔다면 기본적인 문서를 만들기 위한 준비는 이미 끝났습니다.

사이트 구조

여러분의 사이트 구조는 아래와 비슷하게 만들어졌을 겁니다.

root-directory
├── docs
└── website
    ├── blog
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static

위의 구조는 설치하기 단계에서 실행한 스크립트로 생성된 예제 .md 파일을 삭제한 상태임을 가정한 것입니다.

생성할 모든 문서 파일은 docs 디렉토리 안에 있어야 하고 문서의 확장자는 마크다운 확장자인 .md 형태로 생성해야 합니다. 블로그 포스트로 작성된 문서는 blog 디렉토리 안에 위치해야 합니다.

블로그 문서는 YYYY-MM-DD-your-file-name.md 형식으로 파일명을 작성해야 합니다.

기본 사이트 만들기

완전한 구조를 가진 사이트를 만들기 위해서는 몇 개의 단계만 필요합니다.

  1. /docs 디렉토리에 .md 확장자로 작성된 문서 파일을 생성합니다. 생성된 파일에는 적절한 header 값이 들어가야 합니다. One example header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.

    ---
id: intro
title: Getting Started
---
My new content here..

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar if you choose them to be.

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
  3. 이미지 파일 같은 리소스는 website/static/ 디렉토리 아래에 배치합니다.
  4. Run the site to see the results of your changes.
cd website
yarn run start # or `npm run start`
# Navigate to http://localhost:3000

웹사이트를 좀 더 특별하게 만들기

문서 랜딩 페이지

랜딩 페이지에서 여러분의 문서로 바로 이동하기를 원한다면 리다이렉트 기능을 활용할 수 있습니다.

  1. Remove the index.js file from the website/pages directory, if it exists.
  2. 정적 index.html 페이지를 아래와 같은 내용으로 채우고 website/static 디렉토리에 추가합니다.
<!DOCTYPE html>
<html lang="en-US">
  <head>
    <meta charset="UTF-8" />
    <meta
      http-equiv="refresh"
      content="0; url=docs/id-of-doc-to-land-on.html"
    />
    <script type="text/javascript">
      window.location.href = 'docs/id-of-doc-to-land-on.html';
    </script>
    <title>Your Site Title Here</title>
  </head>
  <body>
    If you are not redirected automatically, follow this
    <a href="docs/id-of-doc-to-land-on.html">link</a>.
  </body>
</html>

You will get the id of the document to land on the .md metadata of that doc page.

블로그만 운영하고자 할때

도큐사우르스를 블로그 전용으로 사용할 수도 있습니다.

← Site PreparationPublishing your site →