Skip to content

위키 수정 가이드

위키를 컨텐츠를 처음 수정한다면, 이 문서를 먼저 읽어보세요.

권한을 먼저 얻으세요!

위키의 컨텐츠를 수정하려면, 위키 컨텐츠를 보관하는 저장소에 대한 쓰기 권한이 먼저 필요합니다. S.OWL 운영진에 문의하여 쓰기 권한을 먼저 얻으세요.

기본적인 컨텐츠 수정 방법

웹 편집기에서 수정하기

  • 편집 하고자 하는 문서의 페이지로 이동합니다.
  • 화면 우측 상단의 편집 버튼을 누릅니다.
  • GitHub 에 로그인 하지 않았다면, 로그인 화면이 나옵니다. 로그인 하세요.
  • 편집기 화면이 나타납니다. 마크다운 문법과 위키가 지원하는 추가적인 문법에 따라 문서를 수정합니다.
  • 저장하려면, 페이지 하단으로 이동하여 Commit changes 에서 변경 사항에 대한 설명을 작성한 뒤, Commit changes 또는 Propose file change 로 나타나는 녹색 버튼을 누릅니다.

컨텐츠 저장소 로컬로 복제하여 수정하기

  • 저장소를 로컬로 복제 하고, master 가지로 변경합니다.
  • 위키 컨텐츠 수정은 master 가지에서 이뤄집니다.  - 수정을 완료하지 않았으나 중간 작업사항 커밋을 하는 경우, 별도 브랜치를 분기하여 커밋할 수 있습니다.
git clone https://github.com/s-owl/wiki.git
  • 원하는 문서를 수정합니다.

아래와 같은 파일은 수정하면 안됩니다!

아래와 같은 파일들은 위키 페이지 빌드 및 배포에 사용됩니다, 잘못 수정하면 빌드에 문제가 생기므로 수정하지 마세요. requirements.txt

  • 문서는 마크다운 문법으로 작성하도록 합니다.
  • 새로운 문서를 추가한 경우에는 사이드바에 보이도록 mkdocs.yml 파일을 수정합니다.
...
pages:
  - S.OWL Wiki: index.md
  - 위키 수정 가이드: HowToEdit.md
  - (제목): 파일경로.md
  - 그룹:
    - 그룹의 하위 항목: 하위항목/파일경로.md
  • 커밋하고 master 가지에 푸시 합니다. gh-pages 가지에는 푸시 하시면 안 됩니다. 웹 사이트 갱신중 오류가 발생 할 수 있습니다.
 git add .
 git commit -m "변경 사항에 대한 설명"
 git push origin master
  • 위키 사이트에 접속하여, 변경 사항이 적용 되었는지 확인합니다.
  • 여기에서 사이트 업데이트 현황을 확인 하실 수 있습니다.

마크다운 문법


# 제목1
## 제목2
### 제목3
#### 제목4
##### 제목5

> nVidia, F*ck you!
> - Linus Torvalds

제목1

제목2

제목3

제목4

제목5

nVidia, F*ck you! - Linus Torvalds


**굵은 글씨** *기울인 글씨*  
~~레드준표 曰, “야들아 내가 너희들의 롤 모델이다. 그런데 왜 나를 싫어하냐?” 젊은이들 曰 “지랄 염병”~~  
[여기에는 링크를 걸 텍스트를](여기에 링크를)  
[예시 : GitHub](https://github.com)

굵은 글씨 기울인 글씨
레드준표 曰, “야들아 내가 너희들의 롤 모델이다. 그런데 왜 나를 싫어하냐?” 젊은이들 曰 “지랄 염병”
여기에는 링크를 걸 텍스트를
예시 : GitHub


이미지 삽입
![이미지 설명](https://octodex.github.com/images/yaktocat.png)

이미지 삽입 이미지 설명


줄바꿈을 하려면, 그 줄의 가장 끝에서 두번 띄어쓰기 하고, 줄바꿈을 합니다.  
그러면 이렇게 줄바꿈이 되어 표시됩니다.

한번 띄어씌기 하거나, 띄어씌기 없이 줄바꿈 하면,
이렇게 그냥 한 줄에 나옵니다.

줄바꿈을 하려면, 그 줄의 가장 끝에서 두번 띄어쓰기 하고, 줄바꿈을 합니다.
그러면 이렇게 줄바꿈이 되어 표시됩니다.

한번 띄어씌기 하거나, 띄어씌기 없이 줄바꿈 하면, 이렇게 그냥 한 줄에 나옵니다.


아래와 같은 방식으로, `코드 스니펫`을 넣을 수 있습니다.
```c
  #include <stdio.h>

  int main(void){
   prtinf("Hello World!\n");

   return 0;
  }
  ```

아래와 같은 방식으로, 코드 스니펫을 넣을 수 있습니다.

#include <stdio.h>

int main(void){
 prtinf("Hello World!\n");

 return 0;
}


### 순서 없는 목록A
- 순서 없는 목록0
- 순서 없는 목록1
    - 순서 없는 목록1.1
    - 순서 없는 목록1.2
- 순서 없는 목록2

### 순서 없는 목록B
* 순서 없는 목록0
* 순서 없는 목록1
    * 순서 없는 목록1.1
    * 순서 없는 목록1.2
* 순서 없는 목록2

### 순서 있는 목록
1. 순서 있는 목록1
2. 순서 있는 목록2
3. 순서 있는 목록3

순서 없는 목록A

  • 순서 없는 목록0
  • 순서 없는 목록1
    • 순서 없는 목록1.1
    • 순서 없는 목록1.2
  • 순서 없는 목록2

순서 없는 목록B

  • 순서 없는 목록0
  • 순서 없는 목록1
    • 순서 없는 목록1.1
    • 순서 없는 목록1.2
  • 순서 없는 목록2

순서 있는 목록

  1. 순서 있는 목록1
  2. 순서 있는 목록2
  3. 순서 있는 목록3

 - [x] 이건 이미 다 한것 같고
 - [ ] 이제 이걸 해야 하나

할 일 | 완료 여부 | 비고
---|---|---
삽질 | 모름 | 별로 하고 싶지 않음
코딩 | 미완성 | 디버깅 거지같...
  • 이건 이미 다 한것 같고
  • 이제 이걸 해야 하나
할 일 완료 여부 비고
삽질 모름 별로 하고 싶지 않음
코딩 미완성 디버깅 거지같...
---
!!! info "정보 배너"
    정보 배너 내용

!!! note "노트 배너"
    노트 배너 내용

!!! summary "요약 배너"
    요약 배너 내용

!!! tip "팁 배너"
    팁 배너 내용   

!!! success "성공 배너"
    성공 배너 내용  

!!! question "질문 배너"
    질문 배너 내용  

!!! warning "주의 배너"
    주의 배너 내용

!!! fail "실패 배너"
    실패 배너 내용

!!! danger "위험 배너"
    위험 배너 내용

!!! bug "버그 배너"
    버그 배너 내용

!!! quote "인용 배너"
    인용 배너 내용

정보 배너

정보 배너 내용

노트 배너

노트 배너 내용

요약 배너

요약 배너 내용

팁 배너

팁 배너 내용

성공 배너

성공 배너 내용

질문 배너

질문 배너 내용

주의 배너

주의 배너 내용

실패 배너

실패 배너 내용

위험 배너

위험 배너 내용

버그 배너

버그 배너 내용

인용 배너

인용 배너 내용