๋ณธ๋ฌธ์œผ๋กœ ๊ฑด๋„ˆ๋›ฐ๊ธฐ

Docusaurus์™€ ์ฒซ ๋งŒ๋‚จ ๐Ÿฆ–

ยท ์•ฝ 4๋ถ„
์‹ฌ์™„

์–ด๋Š ๋‚  ์ •๋ง ์šฐ์—ฐํžˆ Docusaurus๋ฅผ ์•Œ๊ฒŒ ๋˜์—ˆ์Šต๋‹ˆ๋‹ค.

GitHub.io์— ๋ฐฐํฌ๋œ ๋ธ”๋กœ๊ทธ์˜€๋Š”๋ฐ ์ •๋ง ์˜ˆ์˜๊ณ , ํŽธํ•ด๋ณด์˜€์Šต๋‹ˆ๋‹ค. ๊ทธ๋ฆฌ๊ณ  ๊ทธ ๋ธ”๋กœ๊ทธ์˜ Footer์— ์ ํ˜€์žˆ๋˜ ๋‹จ์–ด ~ Built with Docusaurus.

๋ธ”๋กœ๊ทธ๋กœ์จ์˜ Docusaurus ๐Ÿฆ–โ€‹

์ง€๊ธˆ๊นŒ์ง€ ์‚ฌ์šฉํ•ด๋ณธ ์ •์  ์‚ฌ์ดํŠธ ์ƒ์„ฑ๊ธฐ๋Š” Jekyll, Hugo ๋“ฑ์ด ์žˆ์—ˆ๋Š”๋ฐ, Docusaurus๊ฐ€ ๊ฐ€์žฅ ์‚ฌ์šฉํ•˜๊ธฐ ํŽธํ–ˆ์Šต๋‹ˆ๋‹ค.

Docusaurus๋ž€? ๐Ÿค”โ€‹

Docusaurus๋Š” Meta์—์„œ ๋งŒ๋“  ์˜คํ”ˆ์†Œ์Šค ํ”„๋กœ์ ํŠธ๋กœ, React ๊ธฐ๋ฐ˜์˜ ์ •์  ์‚ฌ์ดํŠธ ์ƒ์„ฑ๊ธฐ์ž…๋‹ˆ๋‹ค.

์žฅ์  ๐ŸŽ‰โ€‹

1. React ๊ธฐ๋ฐ˜ ๐Ÿ“ฑโ€‹

React ๊ธฐ๋ฐ˜์˜ ์ •์  ์‚ฌ์ดํŠธ ์ƒ์„ฑ๊ธฐ์ด๊ธฐ ๋•Œ๋ฌธ์—, React๋ฅผ ์‚ฌ์šฉํ•ด๋ณธ ๊ฒฝํ—˜์ด ์žˆ๋‹ค๋ฉด ๋น ๋ฅด๊ฒŒ ๋ธ”๋กœ๊ทธ๋ฅผ ๋งŒ๋“ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

2. ์ž˜ ์ž‘์„ฑ๋œ ๊ฐ€์ด๋“œ ๋ฌธ์„œ ๐Ÿ“šโ€‹

Meta์—์„œ ๋งŒ๋“  ํ”„๋กœ์ ํŠธ์ด๊ธฐ ๋•Œ๋ฌธ์—, ๊ฐ€์ด๋“œ ๋ฌธ์„œ๊ฐ€ ์ž˜ ์ž‘์„ฑ๋˜์–ด์žˆ์Šต๋‹ˆ๋‹ค. Docusaurus ๊ณต์‹ ๋ฌธ์„œ๋ฅผ ๋ณด๋ฉด์„œ ๋ธ”๋กœ๊ทธ๋ฅผ ๋งŒ๋“ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

3. ํŽธ๋ฆฌํ•œ ๊ธฐ๋Šฅ๋“ค ๐Ÿ› โ€‹

Docusaurus๋Š” ๋ธ”๋กœ๊ทธ๋ฅผ ๋งŒ๋“ค ๋•Œ ํ•„์š”ํ•œ ๊ธฐ๋Šฅ๋“ค์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค. ๋ธ”๋กœ๊ทธ๋ฅผ ๋งŒ๋“ค ๋•Œ ํ•„์š”ํ•œ ๊ธฐ๋Šฅ๋“ค์„ ์ œ๊ณตํ•˜๊ธฐ ๋•Œ๋ฌธ์—, ๋ธ”๋กœ๊ทธ๋ฅผ ๋งŒ๋“ค ๋•Œ ์‹œ๊ฐ„์„ ์ ˆ์•ฝํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

4. ์ปค๋ฎค๋‹ˆํ‹ฐ ํ™œ์„ฑํ™” ๐Ÿคโ€‹

Docusaurus ๊ณต์‹ Discord ์ฑ„๋„์—์„œ ์งˆ๋ฌธ์„ ํ•˜๋ฉด ๋น ๋ฅด๊ฒŒ ๋‹ต๋ณ€์„ ๋ฐ›์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

5. GitHub Pages ํ˜ธ์ŠคํŒ… ๐Ÿš€โ€‹

GitHub Pages๋ฅผ ํ˜ธ์ŠคํŒ… ์„œ๋ฒ„๋กœ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. GitHub Pages๋ฅผ ํ˜ธ์ŠคํŒ… ์„œ๋ฒ„๋กœ ์‚ฌ์šฉํ•˜๋ฉด, ๋ธ”๋กœ๊ทธ๋ฅผ ๋งŒ๋“ค๊ณ  ๋ฐฐํฌํ•˜๋Š” ๊ณผ์ •์„ ๊ฐ„๋‹จํ•˜๊ฒŒ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

6. ํ…Œ๋งˆ ๐ŸŽจโ€‹

Docusaurus๋Š” ๊ธฐ๋ณธ ํ…Œ๋งˆ ์™ธ์—๋„ ์—ฌ๋Ÿฌ ํ…Œ๋งˆ๋ฅผ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค. Docusaurus ๊ณต์‹ ํ…Œ๋งˆ๋ฅผ ๋ณด๋ฉด์„œ ๋ธ”๋กœ๊ทธ๋ฅผ ๋งŒ๋“ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

7. ์ž์—ฐ์Šค๋Ÿฌ์šด GitHub ์ž”๋”” ์‹ฌ๊ธฐ ๐ŸŒฑโ€‹

GitHub ์ž”๋””๋ฅผ ์‹ฌ๊ธฐ ์œ„ํ•ด, GitHub Actions๋ฅผ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. GitHub Actions๋ฅผ ์‚ฌ์šฉํ•˜๋ฉด, ์ž์—ฐ์Šค๋Ÿฝ๊ฒŒ GitHub ์ž”๋””๋ฅผ ์‹ฌ์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๊ธฐ๋Šฅ ๐Ÿ› โ€‹

๋ฌธ์„œ๋ฅผ ๋งŒ๋“ค ๋•Œ ์‚ฌ์šฉํ•˜๊ธฐ ํŽธ๋ฆฌํ•œ ๋‹ค์–‘ํ•œ ๊ธฐ๋Šฅ๋“ค์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.

  • Markdown ๋ฌธ์„œ ์ž‘์„ฑ
  • ๋ฌธ์„œ ๋ฒ„์ „ ๊ด€๋ฆฌ
  • ์นดํ…Œ๊ณ ๋ฆฌ ๋ฐ ํƒœ๊ทธ
  • i18n
  • ๊ฒ€์ƒ‰

Docusaurus๋กœ ๋ธ”๋กœ๊ทธ ๋งŒ๋“ค๊ธฐ ๐Ÿ“โ€‹

๊ตญ๋‚ด ๊ฐœ๋ฐœ์ž๋“ค์ด ๋งŽ์ด ์‚ฌ์šฉํ•˜๋Š” ๋ธ”๋กœ๊ทธ ํ”Œ๋žซํผ Tistory, Velog, Notion ๋“ฑ์„ ์‚ฌ์šฉํ•ด๋ณด์•˜์ง€๋งŒ, ๋ธ”๋กœ๊ทธ๋ฅผ ๋งŒ๋“ค ๋•Œ ์ œ์•ฝ์‚ฌํ•ญ์ด ๋งŽ์•˜์Šต๋‹ˆ๋‹ค.

๋” ๋งŽ์€ ์‚ฌ๋žŒ๋“ค์ด ๋ธ”๋กœ๊ทธ๋ฅผ ๋งŒ๋“ค ์ˆ˜ ์žˆ๋„๋ก, Docusaurus ๋ธ”๋กœ๊ทธ๋ฅผ ๋งŒ๋“œ๋Š” ๊ฐ„๋‹จํ•œ ๊ฐ€์ด๋“œ๋ฅผ ์ž‘์„ฑํ•ด๋ณด์•˜์Šต๋‹ˆ๋‹ค.

๋งํฌ : Docusaurus ํŠœํ† ๋ฆฌ์–ผ ๐Ÿฆ–

๋งˆ์น˜๋ฉฐ ๐ŸŽ‰โ€‹

์•„์ง ์ถ”๊ฐ€ํ•˜์ง€ ๋ชปํ•œ ๊ธฐ๋Šฅ์ด ๋งŽ์ง€๋งŒ, ์•ž์œผ๋กœ ๊ณ„์† ๊ตฌํ˜„ํ•ด๋‚˜๊ฐ€๋ฉฐ Tutorial์— ์ถ”๊ฐ€ํ•  ์˜ˆ์ •์ž…๋‹ˆ๋‹ค.