Skip to content

Latest commit

ย 

History

History
143 lines (98 loc) ยท 2.57 KB

File metadata and controls

143 lines (98 loc) ยท 2.57 KB

OpenStack ์‹ค์Šต ๋ฐ๋ชจ ํŽ˜์ด์ง€ with Quarto

Quarto๋ฅผ ์ด์šฉํ•œ OpenStack Korea Community ์›น์‚ฌ์ดํŠธ ํ”„๋กœ์ ํŠธ์ž…๋‹ˆ๋‹ค.

ํ”„๋กœ์ ํŠธ ๊ตฌ์กฐ

.
โ”œโ”€โ”€ _quarto.yml     # Quarto ์„ค์ • ํŒŒ์ผ
โ”œโ”€โ”€ index.qmd       # ๋ฉ”์ธ ํŽ˜์ด์ง€
โ”œโ”€โ”€ guides/         # ์‹ค์Šต ๊ฐ€์ด๋“œ
โ”‚   โ”œโ”€โ”€ basic.qmd   # ๊ธฐ๋ณธ ์‹ค์Šต
โ”‚   โ””โ”€โ”€ advanced.qmd # ๊ณ ๊ธ‰ ์‹ค์Šต
โ”œโ”€โ”€ lectures/       # ๊ฐ•์˜ ์ž๋ฃŒ
โ”‚   โ””โ”€โ”€ index.qmd
โ”œโ”€โ”€ community.qmd   # ์ปค๋ฎค๋‹ˆํ‹ฐ ํŽ˜์ด์ง€
โ”œโ”€โ”€ styles.css      # ์ปค์Šคํ…€ ์Šคํƒ€์ผ
โ””โ”€โ”€ docs/          # ๋นŒ๋“œ๋œ ์‚ฌ์ดํŠธ (์ž๋™ ์ƒ์„ฑ)

์‹œ์ž‘ํ•˜๊ธฐ

  1. Quarto ์„ค์น˜
# macOS
brew install quarto

# Windows
choco install quarto

# Linux
wget https://github.com/quarto-dev/quarto-cli/releases/download/v1.6.0/quarto-1.6.0-linux-amd64.deb
sudo dpkg -i quarto-1.6.0-linux-amd64.deb
  1. ์˜์กด์„ฑ ์„ค์น˜
npm install

ํŽ˜์ด์ง€ ์ž‘์„ฑ ๊ฐ€์ด๋“œ

์ƒˆ ํŽ˜์ด์ง€ ์ถ”๊ฐ€

  1. .qmd ํŒŒ์ผ ์ƒ์„ฑ
---
title: "ํŽ˜์ด์ง€ ์ œ๋ชฉ"
---

# ๋‚ด์šฉ ์ž‘์„ฑ
  1. _quarto.yml์— ๋„ค๋น„๊ฒŒ์ด์…˜ ์ถ”๊ฐ€
website:
  navbar:
    left:
      - text: "์ƒˆ ๋ฉ”๋‰ด"
        file: path/to/new.qmd

์‹ค์Šต ๊ฐ€์ด๋“œ ์ž‘์„ฑ

์‹ค์Šต ๊ฐ€์ด๋“œ๋Š” guides/ ๋””๋ ‰ํ† ๋ฆฌ์— ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ ํ…œํ”Œ๋ฆฟ:

---
title: "์‹ค์Šต ์ œ๋ชฉ"
---

# ๊ฐœ์š”

## ์ค€๋น„์‚ฌํ•ญ

## ์‹ค์Šต ๋‹จ๊ณ„

## ๋ฌธ์ œํ•ด๊ฒฐ

๊ฐ•์˜ ์ž๋ฃŒ ์ถ”๊ฐ€

  1. PDF ํŒŒ์ผ์„ materials/ ๋””๋ ‰ํ† ๋ฆฌ์— ์ €์žฅ
  2. lectures/index.qmd์— ๋งํฌ ์ถ”๊ฐ€

์‚ฌ์ดํŠธ ๋นŒ๋“œ ๋ฐ ๋ฐฐํฌ

๋กœ์ปฌ ํ”„๋ฆฌ๋ทฐ

quarto preview

์‚ฌ์ดํŠธ ๋นŒ๋“œ

quarto render

๋นŒ๋“œ๋œ ํŒŒ์ผ์€ docs/ ๋””๋ ‰ํ† ๋ฆฌ์— ์ƒ์„ฑ๋ฉ๋‹ˆ๋‹ค.

GitHub Pages ๋ฐฐํฌ

  1. docs/ ๋””๋ ‰ํ† ๋ฆฌ๋ฅผ Git์— ์ปค๋ฐ‹
  2. GitHub ์ €์žฅ์†Œ ์„ค์ •์—์„œ GitHub Pages ์†Œ์Šค๋ฅผ docs/ ํด๋”๋กœ ์„ค์ •

๋‹ค๊ตญ์–ด ์ง€์›

ํ•œ๊ธ€ ์ฝ˜ํ…์ธ  ์ž‘์„ฑ์„ ์œ„ํ•ด _quarto.yml์— ๋‹ค์Œ ์„ค์ •์ด ๋˜์–ด์žˆ์Šต๋‹ˆ๋‹ค:

format:
  html:
    lang: ko

๊ธฐ์—ฌํ•˜๊ธฐ

  1. ์ด ์ €์žฅ์†Œ๋ฅผ Forkํ•ฉ๋‹ˆ๋‹ค
  2. ์ƒˆ๋กœ์šด ๋ธŒ๋žœ์น˜๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค
  3. ๋ณ€๊ฒฝ์‚ฌํ•ญ์„ ์ปค๋ฐ‹ํ•ฉ๋‹ˆ๋‹ค
  4. Pull Request๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค

๋ฌธ์„œ ์Šคํƒ€์ผ ๊ฐ€์ด๋“œ

  • ์ œ๋ชฉ์€ #๋ถ€ํ„ฐ ์‹œ์ž‘
  • ์ฝ”๋“œ ๋ธ”๋ก์€ ``` ์‚ฌ์šฉ
  • ์ด๋ฏธ์ง€๋Š” images/ ๋””๋ ‰ํ† ๋ฆฌ์— ์ €์žฅ
  • ๋งํฌ๋Š” ์ƒ๋Œ€ ๊ฒฝ๋กœ ์‚ฌ์šฉ

๋„์›€๋ง

๋ผ์ด์„ ์Šค

์ด ํ”„๋กœ์ ํŠธ๋Š” MIT ๋ผ์ด์„ ์Šค ํ•˜์— ๋ฐฐํฌ๋ฉ๋‹ˆ๋‹ค.