🔰

Zennの記事作成方法

2022/05/08に公開

Zennを始めたので、自分用に記事作成方法をまとめる

環境準備

Zenn CLIをインストールし、Githubと連携する
https://zenn.dev/zenn/articles/install-zenn-cli

記事の新規作成

新規作成コマンド
npx zenn new:article --slug {記事のスラッグ} --title {記事のタイトル} --type {tech or tech} --emoji {絵文字}
  • slug

    • 記事のユニークIDで、slugは記事のURLに含まれる(https://zenn.dev/ユーザー名/articles/{slug}
    • slugは半角英小文字(a-z)、半角数字(0-9)、ハイフン(-)、アンダースコア(_)の12〜50字の組み合わせにする必要がある
    • 一度記事を公開すると変更できない(slugを変更すると別記事扱いとなる)
  • title
    記事のタイトル

  • type
    tech or idea

  • emoji
    アイキャッチとして使われる絵文字
    (mac)ショートカットキーで入力できる
    control + command + space

記事の編集

Markdown記法

https://zenn.dev/zenn/articles/markdown-guide

目次

  • 記事内のh1h2の見出しが目次になる

画像の挿入

https://zenn.dev/zenn/articles/deploy-github-images

  • リポジトリ直下の/imagesディレクトリに画像ファイルを配置する

  • 画像を参照するには、/images/から始まる絶対パスを指定する
    ![](/images/example-image.png)

  • 画像ファイルのサイズ上限は3MB

  • ファイル形式は.png .jpg .jpeg .gif

記事の確認

プレビューコマンド
npx zenn preview

記事の公開

  • コミットすると自動的にZennへデプロイされる
  • コミットメッセージに[ci skip] または [skip ci] が含まれているとZennへのデプロイがスキップされる

記事の削除

  • Zenn cliでは削除できないため、ダッシュボード画面から削除する

Discussion