pr0gr4m / Hello-C-World

C언어 기본서 오픈 집필 (오탈자, 내용 문제 등 신고 환영합니다.)
GNU General Public License v3.0
73 stars 6 forks source link

mdbook 마이그레이션 - SUMMARY.md 설정 및 구조 #4

Open netpyoung opened 8 months ago

netpyoung commented 8 months ago

따라서 현재 SUMMARY.md는 #2 에서 올린것과 같이 /01. C언어 소개 폴더를 다음과 같이 /src/01-introduce-c로 원본을 유지한 비파괴로 일부만 마이그레이션 하였습니다.

다음으로 필요한 것들은

  1. /01. C언어 소개 및 기타 다른 폴더들을 /src/01-introduce-c와 같은 폴더로 옮기는 작업이 필요합니다.
    • 중복된 데이터를 관리하기 힘드므로
  2. SUMMARY.md를 위한 폴더 구조가 필요합니다.
    • url깨짐을 방지하고자/src/01. C언어 소개가 아닌 임의로 /src/01-introduce-c와 같은 이름으로 변경하였으나 한글폴더명으로 갈 것인지 대응하는 영문으로 갈것인지 결정해야합니다.
  3. SUMMARY.md를 위한 섹션 구조가 필요합니다.
    • mdbook의 SUMMARY.md는 #을 지원하지 않습니다.
      • 01. C언어 소개/README.md/src/01-introduce-c/history.md와 같이 여러 섹션 파일들로 쪼갰습니다.
      • 따라서 마이그레이션시 대응하는 섹션파일들이 필요합니다.
지금의 SUMMARY.md 파일

# Summary

# 01. C언어 소개

- [C언어의 역사](./01-introduce-c/history.md)
- [C언어의 특징](./01-introduce-c/feature.md)
- [실습 환경 구축](./01-introduce-c/setting.md)

추후 챕터의 폴더명의 이름과 섹션명의 이름이 필요함.
지원하지 않는 SUMMARY.md 형식

현재 README.md와 같이 SUMMARY.md를 다음과 같은 형식으로 작성하려 하였지만 mdbook는 지원하지 않았습니다.
이렇게 #이 붙은건 mdbook에서 지원 하지 않음.

- [C언어 소개](./01.%20C언어%20소개/README.md)
  * [C언어의 역사](./01.%20C언어%20소개/README.md#c언어의-역사)
  * [C언어의 특징](./01.%20C언어%20소개/README.md#c언어의-특징)
  * [실습 환경 구축](./01.%20C언어%20소개/README.md#실습-환경-구축)

Ref

pr0gr4m commented 7 months ago

감사합니다~! 섹션 쪼개는건 나중에 한번 작업을 해야겠네요 ㅎ 덕분에 쉽게 설정했습니다!