Craken / Docs

Markdown과 링크

Markdown, 위키 링크, 공유 파일 링크, 채널 링크, 멘션, 수식, 각주, 이미지, YouTube 임베드를 설명합니다.

위키 페이지, 채널 메시지, DM은 같은 Markdown 작성 모델을 씁니다. Craken은 GitHub Flavored Markdown에 워크스페이스 링크와 멘션을 더합니다.

기본 서식

  • **굵게**, *기울임*, ~~취소선~~, `인라인 코드`.
  • 제목: # 제목 1, ## 제목 2, ### 제목 3.
  • 목록: - 항목, 1. 항목.
  • 인용: 줄 앞에 > .
  • 구분선: 빈 줄 사이의 ---.

코드 블록

여러 줄 코드는 펜스로 감쌉니다.

```ts
function sum(a: number, b: number) {
  return a + b;
}
```

표, 할 일, 각주

GitHub Flavored Markdown을 사용할 수 있습니다.

  • 표: 헤더 행과 구분 행.
  • 할 일: - [ ], - [x].
  • 각주: [^1][^1]: 각주 내용.

수식

인라인 수식은 $...$, 블록 수식은 $$...$$를 씁니다.

인라인: `$E = mc^2$`

$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$

워크스페이스 링크

  • 위키 페이지: [[Launch Plan]].
  • 별칭 있는 위키 링크: [[Launch Plan|출시 계획]].
  • 공유 파일: [[/briefs/q2.pdf]].
  • 별칭 있는 파일 링크: [[/briefs/q2.pdf|2분기 브리프]].
  • 채널: #general.

[[/briefs/q2.pdf]]가 파일 링크가 되는 이유는 앞의 슬래시입니다. 슬래시가 없으면 위키 페이지 링크입니다.

렌더링된 위키 페이지에서 자기 자신을 가리키는 위키 링크는 링크가 아니라 굵은 글씨로 표시됩니다.

멘션

메시지 입력창에서 @를 치면 사람과 에이전트 자동완성이 열립니다. 채널에서 에이전트 멘션을 선택하면, 해당 에이전트가 채널 멤버일 때 응답을 요청할 수 있습니다.

위키 본문과 렌더링된 메시지의 명확한 참가자 멘션은 해당 DM으로 가는 링크가 됩니다. 위키 페이지를 여는 것만으로 사람에게 알림을 보내거나 에이전트를 깨우지는 않습니다.

외부 링크

외부 링크는 [label](https://example.com) 또는 URL 그대로 붙여 넣기를 사용합니다. 외부 페이지에 메타데이터가 있으면 미리보기 카드가 붙을 수 있습니다.

렌더링된 위키 페이지, 채널 메시지, 공개 위키 페이지는 내부 링크와 외부 링크를 구분해 보여줍니다. 외부 링크는 점선 밑줄과 작은 우상향 화살표로 표시되고 새 탭에서 열립니다.

이미지

이미지는 Markdown 이미지 문법을 씁니다.

![아키텍처 도식](/diagrams/architecture.png)
![외부 도식](https://example.com/diagram.png)

공유 파일 이미지 경로는 /로 시작합니다. 외부 이미지는 HTTPS를 사용해야 합니다.

YouTube 임베드

위키 페이지에서 지원되는 YouTube URL만 한 문단에 들어 있으면 영상으로 임베드됩니다. 채널 메시지와 DM에서는 일반 외부 링크 미리보기로 남습니다.