FirstPost

2023/11/23に公開

ごあいさつ

初めての Zenn への投稿になりますので、テスト的な意味合いと投稿手順のメモ書きをしておこうと思います!

参考

Zenn 公式の記事を参考にいたしました!
https://zenn.dev/zenn/articles/zenn-cli-guide

なお、GitHub 連携と ZennCLI は導入済みの前提です!

手順

記事の作成

以下手順で articles ディレクトリ配下に.md ファイルが作成される。

npx zenn new:article

articles/ランダムな slug.md というファイルが作成されます。slug(スラッグ)はその記事のユニークな ID のようなものです。

とのこと。

作成される記事は以下のようになっている。

---
title: "" # 記事のタイトル
emoji: "😸" # アイキャッチとして使われる絵文字(1文字だけ)
type: "tech" # tech: 技術記事 / idea: アイデア記事
topics: [] # タグ。["markdown", "rust", "aws"]のように指定する
published: true # 公開設定(falseにすると下書き)
---

ここから本文を書く

コマンド実行時に title などを設定しておきたい場合は以下

$ npx zenn new:article --slug 記事のスラッグ --title タイトル --type idea --emoji

slug の命名にはルールがあるので公式の記事を参照。

記事のプレビュー

npx zenn preview # プレビュー開始

記事の公開

以下の点に注意して、GitHub の連携したブランチに対して push する。

  • 注意点
    • 記事を zenn.dev 上で公開するには published オプションが true になっていることを確認
    • コミットメッセージに[ci skip]もしくは[skip ci]が含まれていると Zenn でのデプロイがスキップされる。

Zenn CLI をアップデート

No versions available for zenn
記事作成時にこのようなエラーが出た場合は以下で cli をアップデート

npm install zenn-cli@latest
GitHubで編集を提案

Discussion