https://github.com/ryosukedtomita/zenn_article_book

zenn用
https://github.com/ryosukedtomita/zenn_article_book

zenn zenn-article zenn-book zenn-cli

Last synced: 3 months ago
JSON representation

zenn用

• Host: GitHub
• URL: https://github.com/ryosukedtomita/zenn_article_book
• Owner: RyosukeDTomita
• License: unlicense
• Created: 2024-05-07T15:38:47.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-29T15:29:56.000Z (over 1 year ago)
• Last Synced: 2025-01-29T16:21:47.937Z (over 1 year ago)
• Topics: zenn, zenn-article, zenn-book, zenn-cli
• Homepage: https://zenn.dev/sigma_tom
• Size: 3.59 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Zenn Article and Zenn book

![un license](https://img.shields.io/github/license/RyosukeDTomita/zenn_article_book)

## INDEX

- [ABOUT](#about)

- [LICENSE](#license)

- [PREPARING](#preparing)

- [HOW TO USE](#how-to-use)

---

## ABOUT

- [Zenn Articles](https://zenn.dev/sigma_tom)

- [Zenn Books](https://zenn.dev/sigma_tom?tab=books)

---

## LICENSE

---

[unlicense](./LICENSE)

---

## PREPARING

> [公式ドキュメントの通りにやるだけ](https://zenn.dev/zenn/articles/install-zenn-cli)

- Zennのアカウントから**GitHubからのデプロイ**を有効化する。

```shell

# install

npm init --yes

npm install zenn-cli

# セットアップ

npx zenn init

```

---

## HOW TO USE

### 記事と本

> [記事と本の作り方](https://zenn.dev/zenn/articles/zenn-cli-guide)

#### 記事を書く

- articles/配下に記事を置く。

```shell

npx zenn new:article

```

- 作成されたファイル内に`published: true`にし，git pushすると公開される。

- 公開前にプレビューする

```shell

npx zenn preview

```

- 満足できたら，`git push`し，zenn側で公開設定を行うと記事が公開される。

#### 本を書く

- books/配下に本を作るためのディレクトリに置く。

```shell

npx zenn new:book

```

### 画像を使う

> [画像の使い方](https://zenn.dev/zenn/articles/deploy-github-images)

- images/配下に画像を置く。

- 参照するときには/から書く。

```

![hoge](/images/test.png)

```

> [!WARNING]

> ../images/test.pngような書き方をしない。

---