My Thoughts on GitBook

GitBook์€ ์ฐธ ์ข‹์€ ์„œ๋น„์Šค์ด๋‹ค. Markdown์ด๋ผ Notion๊ณผ ํ˜ธํ™˜๋„ ์ข‹๊ณ , ํŽ˜์ด์ง€๋„ ๊น”๋”ํ•ด์„œ ํ”„๋ ˆ์  ํ…Œ์ด์…˜๋„ ๊ดœ์ฐฎ๋‹ค. ๋ธ”๋กœ๊ทธ๋Š” ๋‚ ์งœ์ˆœ์œผ๋กœ ๊ธ€์ด ์ •๋ ฌ๋˜์–ด์„œ ๋ฐฐ์šด ๊ฒƒ์„ ์ •๋ฆฌํ•˜๊ธฐ์—” ๋ธ”๋กœ๊ทธ๊ฐ€ ๋ณ„๋กœ ์ ํ•ฉํ•˜๋‹ค๊ณ  ์ƒ๊ฐํ•˜์ง€ ์•Š๋Š”๋‹ค.

๋ฐฐ์šด ๊ฑธ ๋ชจ์•„๋‘๋Š” ๊ณณ์€ ๊ทธ๋ž˜์„œ Notion, GitBook ๊ฐ™์€ ์„œ๋น„์Šค๊ฐ€ ๋ธ”๋กœ๊ทธ๋ณด๋‹ค ๋” ๋›ฐ์–ด๋‚˜๋‹ค๊ณ  ์ƒ๊ฐํ•œ๋‹ค.

Notion์— ๋„๋ฉ”์ธ์„ ์—ฐ๊ฒฐํ•˜๊ฑฐ๋‚˜ oopy ๋“ฑ์„ ์‚ฌ์šฉํ•˜๋Š” ๋ฒ•๋„ ์žˆ์ง€๋งŒ ๋””์ž์ธ์ด ๋” ๋งˆ์Œ์— ๋“ค๊ณ  ์†๋„๋„ ๋นจ๋ผ์„œ GitBook์„ ์“ฐ๊ณ  ์žˆ๋‹ค. GitHub repository์™€ ์—ฐ๋™ํ•ด์„œ ์ž”๋””๋ฅผ ์ฑ„์šฐ๊ธฐ๋„ ์ข‹๋‹ค.

๊ทผ๋ฐ GitBook์˜ ์น˜๋ช…์ ์ธ ๋‹จ์ ์ด ๋ช‡ ๊ฐ€์ง€ ์žˆ๋‹ค.

  • ํ•œ๊ตญ์–ด ์ง€์›์ด ๋„ˆ๋ฌด ๋„ˆ๋ฌด ๋”์ฐํ•˜๋‹ค. ์ด ์ •๋„์ผ ์ˆ˜๊ฐ€ ์žˆ๋‚˜? ํ•œ๊ตญ์–ด๋กœ ์ž‘์„ฑํ•˜๋ฉด ์ž๊พธ ๋ธ”๋ก์˜ ์ฒซ ๊ธ€์ž๊ฐ€ ํŽ˜์ด์ง€์˜ ๋งจ ๋’ค๋กœ ๋ณด๋‚ด์ง„๋‹ค. ๊ทธ๊ฑธ ์ง€์šฐ๋ฉด ๊ฐ€์ƒ์˜ ๊ธ€์ž๋กœ ์ธ์‹๋˜๋Š” ๊ฒƒ์ธ์ง€ ์›๋ž˜ ์žˆ๋˜ ๊ธ€์ž๊ฐ€ ์ง€์›Œ์ง„๋‹ค. ๊ทธ๋ž˜์„œ ํŽ˜์ด์ง€๋ฅผ ๋‚˜๊ฐ”๋‹ค ๋“ค์–ด์˜ค๊ฑฐ๋‚˜, ๋งจ ์ฒซ ๊ธ€์ž๋ฅผ ๊ณต๋ฐฑ์œผ๋กœ ์‹œ์ž‘ํ•˜๊ณ  ๊ธ€์„ ์ ์€ ๋’ค์— ๋‹ค์‹œ ๋Œ์•„๊ฐ€์„œ ๊ณต๋ฐฑ์„ ์‚ญ์ œํ•˜๊ฑฐ๋‚˜, ์˜์–ด๋กœ ์ ๋‹ค๊ฐ€ ํ•œ๊ธ€๋กœ ์“ฐ๊ฑฐ๋‚˜ ํ•˜๋Š” ๋ฐฉ๋ฒ•์ด ์žˆ๋Š”๋ฐ... ํ•  ๋•Œ๋งˆ๋‹ค ์ธ๋‚ด์‹ฌ์ด 1์”ฉ ๋–จ์–ด์ง„๋‹ค. (์ง€๊ธˆ์€ ์ ์‘ํ–ˆ๋‹ค.)

    • Notion๋„ ์ด ์ •๋„๋Š” ์•„๋‹ˆ๋‹ค. ๋…ธ์…˜์—์„œ ํ•œ๊ตญ์–ด๋ž‘ ์ด๋ชจ์ง€๋ฅผ ํ˜ผ์šฉํ•˜๋ฉด ๊ธ€์ž๊ฐ€ ์•ˆ์ ํžˆ๋Š” ๋ฒ„๊ทธ๊ฐ€ ์žˆ๋Š”๋ฐ ๊ทธ๋ƒฅ ํŽ˜์ด์ง€ ๋‚˜๊ฐ”๋‹ค ๋“ค์–ด์˜ค๊ฑฐ๋‚˜ ๋ธ”๋ก์„ ์ง€์šฐ๊ณ  ์ฒ˜์Œ๋ถ€ํ„ฐ ๋‹ค์‹œ ์ ์œผ๋ฉด ๋œ๋‹ค. ๊ทธ๋ฆฌ๊ณ  ์ด๋ชจ์ง€ ์“ธ ์ผ์ด ์–ผ๋งˆ๋‚˜ ๋งŽ๋‹ค๊ณ ...

    • ๋งฅ๋ถ์—์„œ๋งŒ ๊ทธ๋Ÿฌ๋Š” ๊ฒŒ ์•„๋‹ˆ๋ผ ์œˆ๋„์šฐ์—์„œ๋„ ๋™์ผํ•œ ๋ฌธ์ œ๊ฐ€ ๋ฐœ์ƒํ•œ๋‹ค.

    • ์ง€๊ธˆ๋„ ๋ฐœ๊ฒฌํ•˜๋Š” ๋Œ€๋กœ ์ˆ˜์ •์„ ๋งŽ์ด ๊ฑฐ์น˜๊ณ  ์žˆ์ง€๋งŒ, ์œ„์˜ ์‚ฌ์œ  ๋•Œ๋ฌธ์— ์˜คํƒ€, ์‚ญ์ œ๋œ ๊ธ€์ž๋‚˜ ์•Œ ์ˆ˜ ์—†๋Š” ๊นจ์ง„ ๋ฌธ์ž๊ฐ€ ๊ฝค ๋งŽ์ด ๋ณด์ธ๋‹ค. ์›๋ž˜ ์˜คํƒ€๋ฅผ ์ž์ฃผ ๋‚ด๋Š” ์„ฑ๊ฒฉ์ด ์•„๋‹Œ๋ฐ ๋‚˜๋ฆ„ ๋ณด๋ฉด์„œ ์ˆ˜์ •ํ•œ๋‹ค๊ณ  ํ•ด๋„ ์ฒซ ๊ธ€์ž๋งˆ๋‹ค ์ปค์„œ๊ฐ€ ๋’ค๋กœ ๋ณด๋‚ด์ง€๋‹ˆ๊นŒ ์ผ์ผํžˆ ์‹ ๊ฒฝ์“ฐ๊ธฐ๊ฐ€ ์–ด๋ ต๋‹ค.

    • 2018๋…„์— ์ด์Šˆ๊ฐ€ ์˜ฌ๋ผ์™”๋Š”๋ฐ ์•„์ง๋„ ํ•ด๊ฒฐ์ด ์•ˆ๋œ ๊ฒƒ ๊ฐ™๋‹ค.

  • ์ƒˆ๋กœ์šด ๊ธ€์„ publish ํ–ˆ์„ ๋•Œ, ๊ฒฐ๊ณผ๋กœ ์ƒ์„ฑ๋œ GitBook ์‚ฌ์ดํŠธ์— ๋“ค์–ด๊ฐ€์„œ ์•ˆ๋ณด์ด๋ฉด ์ƒˆ๋กœ๊ณ ์นจํ•ด์•ผ ๋ณด์ธ๋‹ค.

  • ๋Œ“๊ธ€ ๊ธฐ๋Šฅ์ด ์—†๋‹ค. ๋‚ด๊ฐ€ ์šด์˜ํ•˜๋Š” ์„œ๋น„์Šค๊ฐ€ ์•„๋‹ˆ๋ผ์„œ Disqus๋‚˜ utterances๋ฅผ ๋‹ฌ ์ˆ˜ ์žˆ๋Š” ๊ฒƒ๋„ ์•„๋‹ˆ๋‹ค. ๋‚˜ ํ˜ผ์ž ๋ณด๋ ค๊ณ  ์ ๋Š” ๊ธ€๋„ ์•„๋‹Œ๋ฐ ์†”์งํžˆ ์ข€ ์•„์‰ฝ๋‹ค.

  • GitHub๊ณผ์˜ ์—ฐ๋™์ด ์žฅ์ ์ด๋ผ๊ณ  ํ–ˆ๋Š”๋ฐ, ์ด๋ฏธ์ง€๋ฅผ ๋ถ™์—ฌ๋„ฃ์œผ๋ฉด GitHub repository์— ์˜ฌ๋ผ๊ฐ„๋‹ค. ๊ทผ๋ฐ ์ด๋ฏธ์ง€๋ฅผ ์˜ฌ๋ฆฐ ๋’ค์— ์‚ญ์ œํ•˜๋ฉด repository์— ๊ทธ๋Œ€๋กœ ๋‚จ์•„์žˆ๋‹ค.

    • ๊ฐ™์€ ์ด๋ฏธ์ง€ ์—ฌ๋Ÿฌ ๊ฐœ๋ฅผ ์‹ค์ˆ˜๋กœ ์˜ฌ๋ ธ๋‹ค๊ฐ€ ์ง€์›Œ๋„ (1), (2), (3), ... ์ด๋Ÿฐ ์‹์œผ๋กœ ๋‹ค ๋‚จ์•„์žˆ๋‹ค. ๊ทธ๋ž˜๋„ ์‚ญ์ œ๋„ GitBook UI ๋‚ด์—์„œ ์ง€์›ํ•˜๋‹ˆ๊นŒ... ์ด๊ฑด ๋„ˆ๋ฌด ๊นŒ๊ณ  ์‹ถ์ง„ ์•Š๋‹ค.

    • ์ง€๊ธˆ ์˜ฌ๋ฆฌ๋ฉด์„œ ๋ฐœ๊ฒฌํ–ˆ๋Š”๋ฐ ์ด๋ฏธ์ง€๋ฅผ ๋ธ”๋ก ๋ฐ‘์— ๊ณ„์ธตํ™”์‹œํ‚ฌ ์ˆ˜ ์—†๋‹ค. List ๋ฐ‘์— ๋‘˜ ๋•Œ ๋…ธ์…˜์€ ์ž๋™์œผ๋กœ ์ด๋ฏธ์ง€๊ฐ€ ์ž‘์•„์ง€๋Š”๋ฐ ์—ฌ๊ธฐ๋Š” bullet point(โ€ข)๊ฐ€ ๊ทธ๋Œ€๋กœ ๋‚จ์•„ ์žˆ๋‹ค.

    • ์ด๋ฏธ์ง€ ํฌ๊ธฐ ์กฐ์ ˆ์ด ์•ˆ๋œ๋‹ค. (๊ทธ๋‚˜๋งˆ Notion๊ณผ ๋‹ฌ๋ฆฌ ์ขŒ/์šฐ/๊ฐ€์šด๋ฐ ์ •๋ ฌ์ด ๊ฐ€๋Šฅํ•œ ๊ฒŒ ์žฅ์ ์ด๊ธด ํ•˜๋‹ค)

  • ๋˜ ๊ฐ€๋” ์šด ๋‚˜์˜๋ฉด ๋ธ”๋ก์„ ์„ ํƒํ•˜๊ณ  ์‹ถ์€๋ฐ ๋ธ”๋ก ํด๋ฆญ์ด ์•ˆ๋˜๊ณ  ๋ธ”๋ก ๋ฐ‘์— + ๋ฒ„ํŠผ์ด ์ž๊พธ ๋ˆŒ๋ ค์„œ ๊ฝค ์—ด ๋ฐ›๋Š”๋‹ค.

  • Unordered list์™€ ordered list๋ฅผ ์„ž์–ด์„œ ๊ณ„์ธตํ™” ํ•ด์„œ ์“ธ ๋•Œ ๋…ธ์…˜์€ 1. ์ด๋ ‡๊ฒŒ ์ ๊ฑฐ๋‚˜ - ์ด๋ ‡๊ฒŒ ์ ์œผ๋ฉด ์ž๋™์œผ๋กœ ๋ณ€ํ™˜๋˜๋Š”๋ฐ, GitBook์—์„œ๋Š” ๊ทธ๊ฒŒ ์•ˆ๋˜๊ณ  ์•„๋ž˜์ฒ˜๋Ÿผ chocolate(:::) ๋ฒ„ํŠผ์„ ์ผ์ผํžˆ ๋ˆŒ๋Ÿฌ์•ผ ๋œ๋‹ค. GitBook์—์„œ๋Š” Notion์— ์ต์ˆ™ํ•ด์ ธ์„œ ๊ทธ๋Ÿฐ๊ฐ€? ๋ถˆํŽธํ•˜๋‹ค.

ํ˜นํ‰์„ ๋‚จ๊ธฐ๊ณ  ์‹ถ์ง„ ์•Š์•˜๋Š”๋ฐ ์ ๊ณ  ๋ณด๋‹ˆ๊นŒ ์†์ด ์ข€ ์‹œ์›ํ•ด์กŒ๋‹ค. ๊ณ ์ณ์กŒ์œผ๋ฉด ์ข‹๊ฒ ๋Š”๋ฐ support๊ฐ€ ๊ทธ๋‹ค์ง€ ํ™œ์„ฑํ™”๋˜์ง€ ์•Š์€ ๊ฒƒ ๊ฐ™๊ธฐ๋„ ํ•˜๊ณ ... ๊ฐˆ์•„ํƒˆ ์ ๋‹นํ•œ ํ”Œ๋žซํผ์ด ์žˆ์œผ๋ฉด ๊ฐˆ์•„ํƒˆ ๊ฒƒ ๊ฐ™๊ธฐ๋„ ํ•˜๋‹ค.

๊ฐˆ์•„ํƒˆ ํ”Œ๋žซํผ์œผ๋กœ ์•Œ์•„๋‘” ๊ฑด ๋‹ค์Œ๊ณผ ๊ฐ™๋‹ค.

Docusaurus๋ฅผ ํ…Œ์ŠคํŠธํ•ด๋ณด๊ณ , ๊ดœ์ฐฎ์œผ๋ฉด Docusaurus+GitHub Pages๋กœ ๊ฐˆ์•„ํƒˆ ์ˆ˜๋„ ์žˆ๋‹ค. ๋‹ค๋งŒ GitBook์„ ์“ฐ๋Š” ์ด์œ ๊ฐ€ ๊ธ€ ์ž‘์„ฑ UI๋ฅผ ์ œ๊ณตํ•ด์ฃผ๋Š” ์ ๋„ ์žˆ๋Š”๋ฐ ์ด๊ฒŒ ์•ˆ๋œ๋‹ค๋ฉด ์•„๋งˆ๋„ meh.

(Edit on 2022-11-10) ๊ฐ‘์ž๊ธฐ ๊นƒ๋ถ ํ•œ๊ธ€ ์ž‘์„ฑ์ด ๋„ˆ๋ฌด ์ž˜ ๋œ๋‹ค. ์ด๊ฒŒ ์—ญ์‹œ ์ œ์ผ ํฐ ๋ฌธ์ œ์˜€๋Š”์ง€... ํ˜นํ‰์€ ์ผ๋‹จ ์ทจ์†Œ. ๊นƒ๋ถ ๊ณ ๋งˆ์›Œ์š”. ๐Ÿ™‡โ€โ™‚๏ธ

(Edit on 2023-02-22) ์ด๋ฒˆ์—” @๋ฅผ ์ด์šฉํ•œ ๊ฒŒ์‹œ๊ธ€ ๋งํฌ ๊ธฐ๋Šฅ์ด ๋จนํ†ต์ด๋‹ค. ์ •์‹  ์ฐจ๋ ค๋ผ ๊นƒ๋ถ ๐Ÿ˜ญ

Last updated