기여를 위한 가이드

이 프로젝트에 대구소프트웨어마이스터고등학교를 거쳐갔다면 누구나 기여할 수 있습니다.

문서 수정

Edit this page 를 클릭 시 해당 파일을 수정하는 Github 로 이동됩니다.

Github 에서 .md 또는 .mdx 확장자에 맞게 문서를 수정하시면 됩니다.

수정한 이후 commit 과 Pull Request 를 생성하면 됩니다.

문서 생성

ask-for-information
├─ docs
│  └─ category
│     └─ category2
│        └─ doc.md
└─ sidebars.js

우리가 주의깊게 살펴봐야 할 부분은 docs 와 sidebars.js 입니다. 기본적으로 모든 문서는 docs 폴더에 있습니다.

또한 문서에 카테고리가 있을 경우 카테고리 이름에 해당하는 폴더를 생성해야합니다.

예시

ask-for-information
├─ docs
│  └─ example
│     └─ docs.md
└─ sidebars.js

작성 방법

확장자는 .md 또는 .mdx 로 작성 가능합니다.

---
id: (파일이름으로 통일)
title: (제목)
---

파일의 제일 상단 부분에 해당 코드를 삽입해야합니다. 또한 파일 이름 네이밍은 snake case 로 생성합니다.

sidebars.js

좌측의 사이드바 관련은 sidebars.js 에서 추가하거나 수정해야합니다.

카테고리 추가시

{
    type: "category",
    label: "name",
    items: ["name/example"]
}

부분을 작성하여 카테고리를 추가 할 수 있습니다. 중첩 카테고리 작성 시 items 부분에 위와 같은 코드를 한번 더 적으시면 됩니다.

카테고리가 아닌 문서를 추가하기 위해서는

ex) docs/interview/frontend.md 를 추가하려면 items: ["interview/frontend"] 를 추가하면 됩니다.

"folder/docs'id"

module.export = {
  docs: [
    // 카테고리 없는 아이템
    "example",
    // 카테고리
    {
      type: "category",
      label: "first",
      items: [
        // 아이템
        "first-example",
        // 카테고리
        {
          type: "category",
          label: "second",
          items: ["first/second/example"]
        }
      ]
    },
    // 카테고리
    {
      type: "category",
      label: "third",
      items: ["third/example"]
    }
  ]
};