• Stars
    star
    232
  • Rank 172,847 (Top 4 %)
  • Language
  • Created about 8 years ago
  • Updated about 3 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

컴공생을 위한 대학 생활 가이드라인

CS Univ Wiki

Univ Wiki (유니브 위키) 의 __첫 프로젝트__로, 컴퓨터 공학과에서 배울수 있는 것들과 알고 있으면 편한 것들에 대해 전반적으로 적어놓는 CS Univ Wiki의 깃헙 레포지토리입니다.

Gitbook : https://cs.univ.wiki / Gitbook

Github Repo : https://github.com/benjioh5/CS-Univ-Wiki

기여하기

기존의 Github 프로젝트의 기여 방식과 동일합니다.

  • 포크 -> 작업 -> 풀 리퀘를 하시면 됩니다.
  • 현재 Gitbook에 작업물을 퍼블리싱하고 있습니다. Gitbook의 요구사항을 맞춰야합니다.
    • Gitbook toolchain에서 기본적인 문서 작성법을 확인해 주셨으면 합니다.
    • 관리 편의를 위해 각각의 __한 챕터는 하나의 폴더와 대응__합니다.
    • 관리 편의를 위해 각각의 __폴더는 README.md 파일을 포함__하고 있어야합니다.
    • SUMMARY.md에 Table of Contents를 기술합니다.
    • Gitbook 플러그인이 적용되어 있습니다. 현재 적용 되어있는 것은 다음과 같습니다.
      • Youtube : gitbook용 유튜브 임베드
      • Katex : LaTeX 지원
      • Mermaid : 다이어그램, 문법은 공식 홈페이지를 참조해주시길 바랍니다.
      • Tonic
      • 지속적으로 플러그인 목록이 바뀔 수 있음으로 /book.json 파일을 확인해주시길 바랍니다.

TODO

  • Gitbook과 인테그레이션
  • 기본적인 문서 작성 완료하기
  • gollum 등의 git 기반 문서 편집의 대안 찾아보기
  • 이전!