Package Exports
- blog-garden-widget
- blog-garden-widget/blog-garden-widget.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (blog-garden-widget) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
๐ฏ Graden Widget
GitHub ์คํ์ผ์ ํฐ์คํ ๋ฆฌ ๋ธ๋ก๊ทธ ํ๋ ๊ธฐ๋ก ์๊ฐํ ์์ ฏ์ ๋๋ค. RSS ํผ๋๋ฅผ ์๋์ผ๋ก ํ์ฑํ์ฌ ์ต๊ทผ 1๋ ๊ฐ์ ๋ธ๋ก๊ทธ ํ๋์ GitHub ์๋์ ๋์ผํ ์คํ์ผ๋ก ๋ณด์ฌ์ค๋๋ค.
โจ ์ฃผ์ ๊ธฐ๋ฅ
- ๐จ GitHub ์คํ์ผ: ์ ํํ GitHub ์๋ ์์ ์ฝ๋ ์ฌ์ฉ
- ๐ก RSS ์๋ ํ์ฑ: RSS ํผ๋์์ ๊ฒ์๋ฌผ ์ ๋ณด ์๋ ์์ง
- ๐ ์๋ ์ ๋ฐ์ดํธ: 24์๊ฐ๋ง๋ค ๋ฐ์ดํฐ ์๋ ๊ฐฑ์
- ๐ฑ ๋ฐ์ํ ๋์์ธ: ๋ชจ๋ฐ์ผ๊ณผ ๋ฐ์คํฌํฑ ๋ชจ๋ ์ง์
- ๐ ํ๊ตญ์ด ์ง์: ํ๊ตญ์ด ๋ ์ง ํ์๊ณผ ๋ฉ์์ง
- โ๏ธ ์์ ์ปค์คํฐ๋ง์ด์ง: ์ ๋ชฉ, ์์, ์ ๋ฐ์ดํธ ์ฃผ๊ธฐ ๋ฑ ์ค์ ๊ฐ๋ฅ
- ๐งน ๋ฉ๋ชจ๋ฆฌ ๊ด๋ฆฌ: destroy() ๋ฉ์๋๋ก ๋ฆฌ์์ค ์ ๋ฆฌ
๐ ๋น ๋ฅธ ์์
1. ์คํฌ๋ฆฝํธ ๋ก๋
<script src="https://cdn.jsdelivr.net/gh/username/tistory-blog-garden-widget@main/tistory-blog-garden-widget.js"></script>2. HTML ์ปจํ ์ด๋ ์์ฑ
<div id="my-tistory-blog-garden-widget"></div>3. ์์ ฏ ์ด๊ธฐํ
const widget = new GradenWidget('#my-tistory-blog-garden-widget', {
rssUrl: 'https://pearlluck.tistory.com/rss',
title: '๋ด ๋ธ๋ก๊ทธ ํ๋'
});๐ ์ฌ์ฉ๋ฒ
๊ธฐ๋ณธ ์ฌ์ฉ๋ฒ
// ๊ฐ์ฅ ๊ฐ๋จํ ์ฌ์ฉ๋ฒ
const widget = new GradenWidget('#container');
// RSS URL๊ณผ ์ ๋ชฉ ์ค์
const widget = new GradenWidget('#container', {
rssUrl: 'https://pearlluck.tistory.com/rss',
title: '๋ด ๋ธ๋ก๊ทธ ํ๋'
});๊ณ ๊ธ ์ค์
const widget = new GradenWidget('#container', {
rssUrl: 'https://pearlluck.tistory.com/rss',
title: '๊ณ ๊ธ ์ค์ ์์ ฏ',
updateInterval: 12 * 60 * 60 * 1000, // 12์๊ฐ๋ง๋ค ์
๋ฐ์ดํธ
showLegend: true,
showFooter: true,
colors: {
0: '#ebedef', // ํ๋ ์์
1: '#9be9a8', // ๋ฎ์ ํ๋
2: '#40c463', // ์ค๊ฐ ํ๋
3: '#30a14e', // ๋์ ํ๋
4: '#216e39' // ์ต๊ณ ํ๋
}
});HTML ์์ฑ์ผ๋ก ์๋ ์ด๊ธฐํ
<div data-tistory-blog-garden-widget
data-rss-url="https://pearlluck.tistory.com/rss"
data-title="์๋ ์ด๊ธฐํ ์์ ฏ"
data-update-interval="86400000"
data-show-legend="true"
data-show-footer="true">
</div>โ๏ธ ์ค์ ์ต์
| ์ต์ | ํ์ | ๊ธฐ๋ณธ๊ฐ | ์ค๋ช |
|---|---|---|---|
rssUrl |
string | 'https://pearlluck.tistory.com/rss' |
RSS ํผ๋ URL |
title |
string | 'ํ๋ ๊ธฐ๋ก' |
์์ ฏ ์ ๋ชฉ |
updateInterval |
number | 86400000 |
์ ๋ฐ์ดํธ ์ฃผ๊ธฐ (๋ฐ๋ฆฌ์ด, 24์๊ฐ) |
showLegend |
boolean | true |
๋ฒ๋ก ํ์ ์ฌ๋ถ |
showFooter |
boolean | true |
ํธํฐ ํ์ ์ฌ๋ถ |
colors |
object | GitHub ์คํ์ผ ์์ | ์์ ์ปค์คํฐ๋ง์ด์ง |
๐ง API ๋ฉ์๋
update()
์๋์ผ๋ก ๋ฐ์ดํฐ๋ฅผ ์ ๋ฐ์ดํธํฉ๋๋ค.
widget.update().then(() => {
console.log('๋ฐ์ดํฐ ์
๋ฐ์ดํธ ์๋ฃ');
});destroy()
์์ ฏ์ ์ ๊ฑฐํ๊ณ ๋ฉ๋ชจ๋ฆฌ๋ฅผ ์ ๋ฆฌํฉ๋๋ค.
widget.destroy();setOptions(newOptions)
์์ ฏ ์ต์ ์ ๋ณ๊ฒฝํฉ๋๋ค.
widget.setOptions({
title: '์๋ก์ด ์ ๋ชฉ',
showLegend: false
});๐ CDN ๋ฐฐํฌ
GitHub Pages
<script src="https://username.github.io/repo-name/tistory-blog-garden-widget.js"></script>jsDelivr
<script src="https://cdn.jsdelivr.net/gh/username/repo-name@main/tistory-blog-garden-widget.js"></script>unpkg (npm ํจํค์ง ๋ฐฐํฌ ํ)
<script src="https://unpkg.com/tistory-blog-garden-widget@1.0.0/tistory-blog-garden-widget.js"></script>๐ฑ ํฐ์คํ ๋ฆฌ ๋ธ๋ก๊ทธ์ ์ฝ์
HTML ํธ์ง๊ธฐ ์ฌ์ฉ
- ํฐ์คํ ๋ฆฌ ๊ด๋ฆฌ์ ํ์ด์ง โ ๊พธ๋ฏธ๊ธฐ โ HTML ํธ์ง
- ์ํ๋ ์์น์ ์์ ฏ ์ฝ๋ ์ฝ์
- ์ ์ฅ ํ ๋ธ๋ก๊ทธ ํ์ธ
์ฌ์ด๋๋ฐ ์์ ฏ์ผ๋ก ์ถ๊ฐ
- ํฐ์คํ ๋ฆฌ ๊ด๋ฆฌ์ ํ์ด์ง โ ๊พธ๋ฏธ๊ธฐ โ ์ฌ์ด๋๋ฐ
- HTML ์์ ฏ ์ถ๊ฐ
- ์์ ฏ ์ฝ๋ ์ฝ์
๐จ ์์ ์ปค์คํฐ๋ง์ด์ง
๊ธฐ๋ณธ GitHub ์คํ์ผ ์์:
colors: {
0: '#ebedef', // ํ๋ ์์ (ํ์)
1: '#9be9a8', // ๋ฎ์ ํ๋ (์ฐํ ์ด๋ก)
2: '#40c463', // ์ค๊ฐ ํ๋ (์ค๊ฐ ์ด๋ก)
3: '#30a14e', // ๋์ ํ๋ (์งํ ์ด๋ก)
4: '#216e39' // ์ต๊ณ ํ๋ (๊ฐ์ฅ ์งํ ์ด๋ก)
}๐ ๋ธ๋ผ์ฐ์ ์ง์
- Chrome 60+
- Firefox 55+
- Safari 12+
- Edge 79+
๐ ๋ฒ์ ํ์คํ ๋ฆฌ
v1.0.0
- ์ด๊ธฐ ๋ฆด๋ฆฌ์ค
- GitHub ์คํ์ผ ํ๋ ๊ธฐ๋ก ์์ ฏ
- RSS ํผ๋ ์๋ ํ์ฑ
- 24์๊ฐ ์๋ ์ ๋ฐ์ดํธ
- ์์ ํ ์ปค์คํฐ๋ง์ด์ง ์ต์