Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

원고 작성 방법 #1

Open
seopbo opened this issue May 1, 2021 · 0 comments
Open

원고 작성 방법 #1

seopbo opened this issue May 1, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@seopbo
Copy link
Member

seopbo commented May 1, 2021

이 글에서는 팀 블로그 원고 작성방법을 안내합니다.
우선 마크다운 문서의 이름과 저장 위치는 다음과 같습니다.

  • 문서 이름 : YYYY-MM-DD-docname.md (예: 2021-03-08-doc.md)
  • 문서 위치 : blog/_posts 디렉토리

다음은 글의 메타 정보를 입력하는 방법입니다.
메타 정보는 마크다운 문서의 맨 처음에 다음과 같이 입력해야 합니다.
각 항목별 설명은 다음과 같습니다.

---
layout: post
title: 원고 작성 방법
author: boseop.kim
categories: [기타]
tags: [documentation, sample]
image: https://i.imgur.com/0Cqav7x.jpg
---
  • layout : post가 기본값입니다. 이 값을 바꾸지 않습니다.
  • title : 문서 제목입니다. 반드시 입력해야 합니다.
  • author : 저자 이름입니다. 저자 이름이 유효하려면 blog/_config.yml 파일에 authors 항목에 등록되어 있어야 합니다. 입력하지 않고 빈칸으로 두어도 됩니다. 저자 정보 등록 방법은 [이 글]({{ site.github.url }}/documentation/writer.html)을 참고하세요.
  • categories : 이 문서의 카테고리 정보입니다. 하나 혹은 그 이상 입력해도 되고 입력하지 않아도 됩니다.
  • tags : 이 문서의 태그 정보입니다. 하나 혹은 그 이상 입력해도 되고 입력하지 않아도 됩니다.
  • image : 이 문서의 메인 이미지입니다. 그림을 입력할 경우 이미지를 imgur에 업로드한 뒤 절대 경로 주소를 이 항목에 기입합니다(업로드 방법은 이 글 하단 참조). 입력하지 않아도 됩니다.

다음은 문서 중간에 제목을 작성하는 방법입니다.
아래처럼 쓰면 다음과 같이 중간 제목, 소제목이 나타납니다.

### 중간 제목

중간 제목입니다.

#### 소제목

소제목입니다.

중간 제목

중간 제목입니다.

소제목

소제목입니다.


다음은 항목을 쓰는 방법입니다.
아래처럼 쓰면 다음과 같이 나타납니다.

1. 이것은 항목 예시입니다.
2. 이것은 항목 예시입니다.
  1. 이것은 항목 예시입니다.
  2. 이것은 항목 예시입니다.
- 이것은 항목 예시입니다.
  - 이것은 항목 예시입니다.
- 이것은 항목 예시입니다.
  • 이것은 항목 예시입니다.
    • 이것은 항목 예시입니다.
  • 이것은 항목 예시입니다.

다음은 코드를 삽입하는 방법입니다.
아래처럼 쓰면 다음과 같이 코드 블럭을 만들 수 있습니다.

```python
print("test!")
```
print("test!")

다음은 인라인 코드를 삽입하는 방법입니다.
아래처럼 쓰면 다음과 같이 인라인 코드를 만들 수 있습니다.

이것은 `예제`입니다.

이것은 예제입니다.


다음은 수식을 삽입하는 방법입니다.
아래처럼 laTex 코드를 쓰면 다음과 같이 수식을 삽입할 수 있습니다.

$$
\mathbf{ h }_{ { z }_{ t } }^{ (m) }\leftarrow \textrm{Attention} \left( \mathbf{Q}=\mathbf{ h }_{ { z }_{ t } }^{ (m-1) },\mathbf{KV}=\mathbf{ h }_{ { z }_{ \le t } }^{ (m-1) };\theta  \right)
$$

$$
\mathbf{ h }{ { z }{ t } }^{ (m) }\leftarrow \textrm{Attention} \left( \mathbf{Q}=\mathbf{ h }{ { z }{ t } }^{ (m-1) },\mathbf{KV}=\mathbf{ h }{ { z }{ \le t } }^{ (m-1) };\theta \right)
$$


다음은 인라인 수식을 삽입하는 방법입니다.
아래처럼 laTex 코드를 쓰면 다음과 같이 수식을 삽입할 수 있습니다.

함수 $f(x)$를 다음과 같이 정의했다고 가정하자.

함수 $f(x)$를 다음과 같이 정의했다고 가정하자.


다음은 표를 삽입하는 방법입니다.
아래처럼 코드를 쓰면 다음과 같이 표를 삽입할 수 있습니다.

|lang|alias|size|
|---|---|---|
|ko|pangyo|13B|
|ko|boss|39B|
|ja|jessica|13B|
|ja|koya|39B|
lang alias size
ko pangyo 13B
ko boss 39B
ja jessica 13B
ja koya 39B

다음은 링크를 삽입하는 방법입니다.
아래처럼 코드를 쓰면 다음과 같이 링크를 삽입할 수 있습니다.

[https://imgur.com](https://imgur.com)에 접속합니다.

https://imgur.com에 접속합니다.


다음은 이미지를 삽입하는 방법입니다.
우선 다음 사이트에 접속해 로그인합니다.

아래처럼 우측 상단 화면의 image를 클릭합니다.

Add images를 클릭해 삽입하려는 이미지를 업로드합니다.

업로드한 이미지를 클릭하면 다음 그림처럼 Direct Link를 얻을 수 있습니다.

이 링크를 복사해 다음처럼 입력하면 아래처럼 그림을 삽입할 수 있습니다.

<img src="https://i.imgur.com/O5GJ8UB.jpg" width="500px">

만일 메타 정보 image에 위 링크를 복사해 붙여 넣으면 해당 그림을 이 원고의 메인 사진으로 사용할 수 있습니다.

@seopbo seopbo added the documentation Improvements or additions to documentation label May 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant