/kcmd-wiki.github.io

Primary LanguageHTMLGNU General Public License v3.0GPL-3.0

kcmd-wiki

https://kcmd-wiki.github.io/




편집 기여하기

https://github.com/kcmd-wiki/content

깃허브 계정이 있으시다면 위 링크에서 누구나 문서 작성과 편집이 가능합니다.

여러가지 버튼을 어떠한 일련의 과정을 통해 잘못 눌렀다가 실수로 여기에 들어와버린 당신조차 말이죠!




페이지 구조

.html 파일 하나만으로 구성된 SPA(싱글 페이지 애플리케이션) 웹사이트이며, 사용자의 컴퓨터에서 여기 깃허브 리포지토리의 데이터를 불러오는 식으로 동작합니다.


하위 페이지

링크의 맨 뒤에 해시(#) 기호와 함께 어떤 문자열이 있으면 content 리포지토리에서 해당 이름의 .md 파일이 불러와집니다.

예를 들어 https://kcmd-wiki.github.io/#test >>> test.md 와 같이 연결됩니다.

하위 페이지는 .md 파일을 불러와서 html 코드로 변환하는 식으로 동작합니다. 여기에 showdownjs가 사용됩니다.


chapters.txt

홈화면의 버튼을 누르면 해시 주소값이 입력되어 하위 페이지로 연결되는걸 확인하실 수 있습니다.

chapters.txt 파일을 수정하여 이러한 버튼과 링크, 부제목을 추가/편집/제거할 수 있습니다.

chapters.txt 파일에서 세미콜론(:) 기호가 정확히 1개 배치되어 있는 텍스트는 버튼으로 인식됩니다. 세미콜론의 왼쪽이 버튼의 이름이며, 오른쪽은 연결할 하위 페이지의 파일명이자 해시 주소입니다. 예를 들어 아래 버튼은 https://kcmd-wiki.github.io/#test 로 연결됩니다.

버튼 이름 : test

일반 텍스트는 부제목으로 인식됩니다.

이건 제목입니다. 예. 이게 제목이라고요.

일반적으로 부제목 밑에 버튼을 나열하는 식으로 페이지가 구성될겁니다. 이건 chapters.txt를 뜯어보시는게 이해가 더 빠를겁니다.

이건 제목입니다. 예. 이게 제목이라고요.
    버튼 이름 : test
    다른 버튼 이름 : a-s-d-f
    버튼 이름을 뭐로 하지 : QWERSDAFASDGREBHRSEG

(chapters.txt 파일은 줄단위로 파싱되며, 줄마다 맨 오른쪽과 맨 왼쪽에 있는 공백은 자동으로 제거됩니다. 비어있는 줄이나, 하이픈(-) 기호로만 이루어져 있는 줄이나, 공백으로만 이루어져 있는 줄 또한 자동으로 제거됩니다.)