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

문서 수정​

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"]
    }
  ]
};

docusaurus 에서의 Markdown 스타일을 위한 가이드입니다.

본 페이지에서는 결과를, 여기 에서는 코드를 확인할 수 있습니다.

Headers​

H1 - Create the best documentation

H2 - Create the best documentation​

H3 - Create the best documentation​

H4 - Create the best documentation​

H5 - Create the best documentation​

H6 - Create the best documentation​

Emphasis​

Emphasis, aka italics, with asterisks or underscores.

Strong emphasis, aka bold, with asterisks or underscores.

Combined emphasis with asterisks and underscores.

Strikethrough uses two tildes. Scratch this.

Lists​

1. First ordered list item
2. Another item
   • Unordered sub-list.
3. Actual numbers don't matter, just that it's a number
   1. Ordered sub-list
4. And another item.

• Unordered list can use asterisks

• Or minuses

• Or pluses

Links​

I'm an inline-style link

I'm an inline-style link with title

I'm a reference-style link

You can use numbers for reference-style link definitions

Or leave it empty and use the link text itself.

URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com/ or http://www.example.com/ and sometimes example.com (but not on GitHub, for example).

Some text to show that the reference links can follow later.

Images​

Here's our logo (hover to see the title text):

Inline-style:

Reference-style:

Code​

var s = "JavaScript syntax highlighting";
alert(s);

s = "Python syntax highlighting"
print(s)

No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.

function highlightMe() {
    console.log("This line can be highlighted!");
}

Tables​

Colons can be used to align columns.

There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.

Blockquotes​

Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.

Quote break.

This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can put Markdown into a blockquote.

Inline HTML​

Definition list

Is something people use sometimes.

Markdown in HTML

Does *not* work **very** well. Use HTML tags.

Line Breaks​

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a separate paragraph.

This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the same paragraph.

Admonitions​