1. MarkDown Wiki 사용 예제 - ohipark/btstack GitHub Wiki

참고자료


예제 시작하기


[0단계] 글자 입력하기

아무 글자나 이렇게 타이핑하면 입력이 된다.

아무 글자나 이렇게 타이핑하면 입력이 된다.


[1단계] 문단 작성 시에 참고할 내용

  • 엔터키(줄바꿈, 개행) : 라인을 바꾸고 싶을 때
  • 특정 단어 등을 강조 : 문장 내 강조하고 싶은 단어를 눈에 띄게
  • 특정 단어 등을 강조 : 배경색을 회색으로 처리
문장 마지막에 띄어쓰기 2번을 입력하던지 <br> 태그를 사용.<br>(from)<br>(to)<br><!-- from과 to 사이에 스페이스 2번 입력-->
줄이 바뀐다.  

문장 마지막에 띄어쓰기 2번을 입력하던지 <br> 태그를 사용.
(from)
(to)
줄이 바뀐다.

__볼드(진하게)__  
_이탤릭체(기울여서)_    
~~취소선~~  
<u>밑줄</u>  
__볼드로 진하게 만들다가 *이탤릭으로 기울이고* 다시 볼드로__(중복 활용도 가능하다.) 

볼드(진하게)
이탤릭체(기울여서)
취소선
밑줄
볼드로 진하게 만들다가 이탤릭으로 기울이고 다시 볼드로(중복 활용도 가능하다.)

배경색을 `회색`으로 처리

배경색을 회색으로 처리
처음으로


[4단계] 목록(list) : 요소를 나열할 때

  1. 첫번째
  2. 두번째
  3. 세번째
  • 순서없음
    • 홍길동
      • 중대장
        • 프로실망러

처음으로


[3단계] 구간을 나누는 선 긋기 : 내용 구간을 명시적으로 구분하고 싶을 때

---

처음으로


[4단계] 특정 구간을 회색으로 강조하고 싶을 때

코드 블록 앞뒤에 삼중 백틱 ```을 배치하여 펜싱된 코드 블록을 만들 수 있습니다. 원시 서식을 더 쉽게 읽을 수 있도록 코드 블록 전후에 빈 줄을 배치하는 것이 좋습니다.

```
function test() {
  console.log("notice the blank line before this function?");
}
```

강조된 코드 블록에 3중 백틱(```)을 표시하려면 4중 백틱(````) 안에 넣습니다.

function test() {
  console.log("notice the blank line before this function?");
}

특정 언어의 구문을 강조해서 표시하기

선택적 언어 식별자를 추가하여 강조된 코드 블록에서 구문을 강조하도록 설정할 수 있습니다.

강조 표시된 구문은 쉽게 읽을 수 있도록 소스 코드의 색과 스타일을 변경합니다.

예를 들어 구문에서 Ruby 코드를 강조 표시하려면 다음을 수행합니다.

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

그러면 구문이 강조 표시된 코드 블록이 표시됩니다.

require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html

GitHub에 표시된 Ruby 코드의 세 줄 스크린샷입니다. 코드의 요소는 스캔하기 쉽도록 보라색, 파란색, 빨간색 유형으로 표시됩니다.

Linguist를 사용하여 언어 검색을 수행하고 구문 강조를 위해 타사 문법을 선택합니다. 언어 YAML 파일에서 유효한 키워드를 확인할 수 있습니다.

처음으로


[5단계] 좌측에 특정 구간을 표시해서 강조하고 싶을 때 (탭 방식으로 중복 형태 가능)

> 위키백과?
>> 중대장 드립 검색
>>> "오늘 중대장은 너희에게 실망했다"

위키백과?

중대장 드립 검색

"오늘 중대장은 너희에게 실망했다"

처음으로


[6단계] URL 링크(Link) : 클릭하면 다른 페이지, 다른 부분으로 이동 가능

유형1(`설명어`를 클릭하면 URL로 이동) : [TheoryDB 블로그](https://theorydb.github.io "마우스를 올려놓으면 말풍선이 나옵니다.")  
유형2(URL 보여주고 `자동연결`) : <https://theorydb.github.io>  
유형3(동일 파일 내 `문단 이동`) : [동일파일 내 문단 이동](#markdown의-반드시-알아야-하는-문법)  
유형4(동일 파일 내 `문단 이동`) : [[0단계] 글자 입력하기](#0단계-글자-입력하기)

유형1(설명어를 클릭하면 URL로 이동) : TheoryDB 블로그
유형2(URL 보여주고 자동연결) : https://theorydb.github.io
유형3(동일 파일 내 문단 이동) : 예제 시작하기 처음으로 이동
유형4(동일 파일 내 문단 이동) : [0단계] 글자 입력하기

유형3 문단 매칭방법 : 제목(header)를 복사 붙여넣기 후,

  1. 특수문자 제거
  2. 스페이스를 갯수만큼 -로 변경
  3. 대문자->소문자로 변경 예) “#Markdown! 장점” -> “#markdown–장점”

처음으로


[7단계] 이미지(Image) : 이미지 보여주기

+ 유형1(`이미지` 삽입) : <br>
![이미지](https://theorydb.github.io/assets/img/think/2019-06-25-think-future-ai-1.png "인공지능")

+ 유형2(`사이즈를 조절`하고 싶은 경우 HTML 태그로 처리) :   
<img src="https://theorydb.github.io/assets/img/think/2019-06-25-think-future-ai-1.png" width="300" height="200"> 

+ 유형3(이미지 삽입 후, `링크 걸기`):<br>
[![이미지](https://theorydb.github.io/assets/img/think/2019-06-25-think-future-ai-1.png)](https://theorydb.github.io/think/2019/06/25/think-future-ai/)<br>

+ 유형4(Copy & Paste로 이미지 삽입 후, `링크 생성`):<br>
<br>

+ 유형5(반응형 이미지 삽입):<br>
<br>
<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/25423296/163456776-7f95b81a-f1ed-45f7-b7ab-8fa810d529fa.png">
  <source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/25423296/163456779-a8556205-d0a5-45e2-ac17-42d089e3c3f8.png">
  <img alt="Shows an illustrated sun in light mode and a moon with stars in dark mode." src="https://user-images.githubusercontent.com/25423296/163456779-a8556205-d0a5-45e2-ac17-42d089e3c3f8.png">
</picture>
  • 유형1(이미지 삽입) :
    이미지
  • 유형2(사이즈를 조절하고 싶은 경우 HTML 태그로 처리) :

  • 유형3(이미지 삽입 후, 링크 걸기) :
    이미지

  • 유형4(Copy & Paste로 이미지 삽입 후, 링크 생성):
    test image

  • 유형5(반응형 이미지 삽입):
    TBD

처음으로


[8단계] 표(Table) : 표 그리기

|                 | 수학                        | 평가              |  
|:--- | ---: | :---: |  
| 철수             | 90            | 참잘했어요. |  
| 영희           | 50            | 분발하세요. |
                                      수학                    평가                   
철수 90 참잘했어요.
영희 50 분발하세요.
  • 라인 단위로 생각하면서 구분자(|)로 열을 구분해주면 위와 같이 대충 그려도 알아서 예쁘게 완성된다.
  • 헤더(머리글)를 분리하고 싶은 경우, 위 예제와 같이 2번째 라인에 ---을 사용하면 된다.
  • 정렬이 필요한 경우, 콜론(:) 기호를 구분선(---) 왼쪽, 오른쪽, 양쪽에 배치한다.

처음으로


[9단계] 수식 입력하기 : 수학, 논문 등에 사용

$$f(x)= if x < x_{min} : (x/x_{min})^a$$
<!-- -->
$$otherwise : 0$$
<!-- -->
$$P(w)=U(x/2)(7/5)/Z$$
<!-- -->
$$p_{\theta}(x) = \int p_{\theta}(2z)p_{\theta}(y\mid k)dz$$
<!-- -->
$$x = argmax_k((x_t-x_u+x_v)^T*x_m)/(||x_b-x_k+x_l||)$$
<!-- -->

$$f(x)= if x < x_{min} : (x/x_{min})^a$$

$$otherwise : 0$$

$$P(w)=U(x/2)(7/5)/Z$$

$$p_{\theta}(x) = \int p_{\theta}(2z)p_{\theta}(y\mid k)dz$$

$$x = argmax_k((x_t-x_u+x_v)^T*x_m)/(||x_b-x_k+x_l||)$$

수식은 $$으로 둘러쌓여야 하고 (),{}으로 감싸면 우선순위를 고려한 동일 단위로 인식한다.

처음으로


[10단계] 코드 블록(Code Block) : 소스코드, 외부 인용자료 블록처리 등에 사용

``python
py_vector = one_hot_encoding("파이",word2index)
py_vector.dot(torch_vector)
>>> 0.0
```

강조 구간 내부에서 백텍을 (```)을 사용하려면 바깥쪽에 백텍은 4개(````)를 사용

py_vector = one_hot_encoding("파이",word2index)
py_vector.dot(torch_vector)
>>> 0.0
  • ```뒤에 python이라고 쓰면 python 언어 스타일에 맞게 구문이 강조된다.
  • 보통 강조하고 싶은 프로그래밍 언어를 그대로 쓰면 된다.
  • ex) bash, cpp, dockerfile, markdown, yml, html, http, json, r, ruby, xml, sql … 등

처음으로


[11단계] 특수 기호나 심볼 사용하기

특수 글자나 심볼 출력하기

| Char | Number | Entity | Description |  
|:---: | :---  | :---  |    :---    |   
|©| \&#169;| \&copy;| COPYRIGHT |  
|® | \&#174;| \&reg; | REGISTERED|  
|♠| \&#9824;| \&spades;| SPADE |  
|∑| \&#8721;| \&sum;| N-ary summation |  
|⛄| \&#9924;| \&#x26C4;| SNOWMAN WITHOUT SNOW |
|☞| \&#9758;| \&#x261E;| WHITE RIGHT POINTING INDEX |
  
&#x2BC8;
Char Number Entity Description
© &#169; &copy; COPYRIGHT
® &#174; &reg; REGISTERED
&#9824; &spades; SPADE
&#8721; &sum; N-ary summation
&#9924; &26C4; SNOWMAN WITHOUT SNOW
&#9758; &261E; WHITE RIGHT POINTING INDEX

:EMOJICODE:, 콜론, 이모지 이름 순으로 입력하여 글에 이모지를 추가할 수 있습니다.

@octocat :+1: This PR looks great - it's ready to merge! :shipit:

@octocat 👍 This PR looks great - it's ready to merge! :shipit:

:을 입력하면 제안된 이모지 목록이 표시됩니다. 입력할 때 목록이 필터링되므로 원하는 이모지를 찾았으면 Tab 또는 Enter 키를 눌러 강조 표시된 결과를 완성합니다.

사용 가능한 이모지 및 코드의 전체 목록을 보려면 Emoji-Cheat-Sheet를 확인하세요.

텍스트 줄 사이에 빈 줄을 두어 새 단락을 만들 수 있습니다.

경고는 중요한 정보를 강조하는 데 사용할 수 있는 blockquote 구문을 기반으로 한 Markdown 확장입니다. GitHub에서는 콘텐츠의 중요도를 나타내기 위해 고유한 색과 아이콘으로 표시됩니다.

경고는 사용자 성공에 중요한 경우에만 사용하고, 판독기 오버로드를 방지하기 위해 문서당 하나 또는 두 개로 제한합니다. 또한 경고를 연속적으로 배치하지 않아야 합니다. 경고는 다른 요소 내에 중첩될 수 없습니다.

경고를 추가하려면 경고 유형을 지정하는 특수 blockquote 줄을 사용하고, 그 다음에는 표준 blockquote의 경고 정보를 사용합니다. 5가지 유형의 경고를 사용할 수 있습니다.

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.

렌더링된 경고는 다음과 같습니다.

Note

Useful information that users should know, even when skimming content.

Tip

Helpful advice for doing things better or more easily.

Important

Key information users need to know to achieve their goal.

Warning

Urgent info that needs immediate user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.

처음으로


[12단계] 다이어그램 만들기

Here is a simple flow chart:

\```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
\```
  • Here is a simple flow chart:
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
Loading
Sequence diagram:

\```mermaid
sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop HealthCheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail!
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!
\```
  • Sequence diagram:
sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop HealthCheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail!
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!
Loading

처음으로


[13단계] 축소된 섹션을 사용하여 단락 구성하기

<details> 태그를 사용하여 축소된 섹션을 만들어 Markdown을 간소화할 수 있습니다.

축소된 섹션 만들기

사용자가 확장하도록 선택할 수 있는 축소된 섹션을 만들어 Markdown의 섹션을 일시적으로 가릴 수 있습니다. 예를 들어, 모든 사용자와 관련이 없거나 흥미롭지 않을 수 있는 이슈 주석에 기술 세부 정보를 포함하려는 경우 해당 세부 정보를 축소된 섹션에 넣을 수 있습니다.

<details> 블록 내의 Markdown은 사용자가 ⯈아이콘을 클릭하여 세부 정보를 확장하기 전까지는 접혀 있습니다.

<details> 블록 내에서 <summary> 태그를 사용하여 판독기 내에 무엇이 있는지 알 수 있습니다. 레이블은 ⯈아이콘의 오른쪽에 표시됩니다.

<details>

<summary>Tips for collapsed sections</summary>

### You can add a header

You can add text within a collapsed section. 

You can add an image or a code block, too.

```ruby
   puts "Hello World"
```
</details>
Tips for collapsed sections

You can add a header

You can add text within a collapsed section.

You can add an image or a code block, too.

   puts "Hello World"


<summary> 레이블 내 Markdown은 기본적으로 축소됩니다. GitHub에 렌더링된 이 페이지 위의 Markdown 스크린샷으로, 오른쪽 화살표와 "축소된 섹션에 대한 팁" 머리글을 보여 줍니다.

사용자가 아이콘을 클릭하면 세부 정보가 확장됩니다.

GitHub에 렌더링된 이 페이지 위의 Markdown 스크린샷으로, 축소된 섹션에 머리글, 텍스트 문장, 이미지 및 코드 블록이 포함될 수 있음을 나타냅니다.

처음으로


⚠️ **GitHub.com Fallback** ⚠️