MarkDown 실시간 서버 확인

문서작성법

시작하기에 앞서 꼭 기억해야 할것은 우리에게는 두가지의 원격저장소가 있다.

하나는, https://github.com/HGUSight/HGUSightblog 이 저장소는 우리의 전체 파일을 수정하고 고치기 위함이다.

두번째는, https://github.com/HGUSight/HGUSight.github.io 이 저장소는 빌드 파일인 site파일만 올려서 우리의 웹페이지를 렌더링하기 위함이다.

다음 명령어를 따라하면, 문제들을 해결하고 올릴수 있다. 하지만 정확한 이해를 위해서는 깃을 공부하는것이 꼭 필요하다.

1. 깃허브에서 레파지토리를 클론해서 가져온다. 작성은 왠만하면 각팀의 팀장이나 문서 작성 담당자 1인이 담당한다.

git clone https://github.com/HGUSight/HGUSightblog

2. pip install mkdocs-material 명령어로 MkDocs 와 Material for MkDocs 를 설치합니다.

   !!! note

    **Windows** 시스템에서는 `python -m pip install mkdocs-material` 명령어를 실행해야 할 수도 있습니다.

3. visual studio code를 이용해서 위에서 클론한 HGUSightblog를 연다. .md 파일을 고치면 웹페이지를 고칠수 있다.

   !!! tip

    mkdocs.yml에서 파일을 렌더링 해준다. 여기 렌더링 하고 싶은 각 .md파일의 경로를 적어주면 된다. 
    만약 고치고 싶다면, 각 .md파일을 수정해주면된다. 
   
    aseets에는 이미지들이 모여 있다. javascripts와 stylesheets은 디자인 테마이므로 건들지 않는다.
   
    ```mkdocs build```를 하면 site라는 폴더가 생긴다. 이 폴더는 깃허브에 공유 용으로 필요한 폴더이므로 이또한 건들지 않는다. 

4. 이제 고친 .md파일을 확인 해보자. 터미널에서 클론한 렟파지토리로 들어간다. 그리고,

   mkdocs serve 를 실행합니다. 그러면 http://localhost:8000 에 Preview 서버가 열립니다.

   !!! note

    여기서 반드시 **확인**을 하고, push을 해야합니다!!!!  
    실시간으로 저장을 하면 변경되는 .md파일이 바로 바로 웹페이지에 보입니다. 

5. 확인까지 완료가 되었다면, 이제 진짜로 수정한 페이지를 적용시켜 보자.

        git rm --cached site -f   
        git add .
        git commit -m "commit message"
        git remote -v 
        //이 명령어를 통해서 반드시 지금 origin이 어떤 저장소를 가르치고 있는지 확인해야한다. 여기서의 정답은 blog이다. 전체파일을 우리는 푸쉬 할것이다. origin https://github.com/HGUSight/HGUSightblog을 가르치고 있다면 그냥 푸쉬하면된다. 아니면 아래 명령어로 추가해주자. 
        git remote add origin https://github.com/HGUSight/HGUSightblog
        git push origin master

   이제 깃허브에 수정된 파일들이 올라갔다. 확인해보자.

6. 마지막으로 자신의 최종 파일들을 빌드하고 빌드된 파일만, 이제 .io 레파지토리에 올린다.

        python3 -m mkdocs build
        cd site
        git add . 
        git commit -m "commit message"
        git remote -v 
        //아마도 여기서 origin은 https://github.com/HGUSight/HGUSightblog를 가르키고 있을것이다. 이것은 잘못된것이므로 origin을 삭제하고 다시 올바른 저장소를 가리키게 할것이다. 
        git remote rm origin
        git remote add origin https://github.com/HGUSight/HGUSight.github.io
        git remote -v
        //다시한번 origin을 체크하고, io를 가리키고 있다면 이제 푸쉬한다. 이때 안올라간다면 뒤에 --force를 붙이면된다. 
        git push origin master

혹시라도 실수로 HGUSight.github.io에 빌드 파일이 아닌 독스나 다른걸 전부 올렸다만, 아래 블로그를 참조해서 원격저장소를 아예 비우고 다시 빌드해서 빌드 파일 즉 site파일만 올려줘야 렌더링이 잘 된다.
https://yoshikixdrum.tistory.com/200

마크다운을 공부할때 참조할 사이트

1.https://gist.github.com/ihoneymon/652be052a0727ad59601

2.https://heropy.blog/2017/09/30/markdown/