🤔

Zennのスラッグ(slug)とは

2022/09/21に公開

slug(スラッグ)は、記事や本のユニークなIDのような文字列です。例えばslugがexample-articleの記事のURLは

https://zenn.dev/ユーザー名/articles/example-article

となります。

slugの指定

ウェブ上で記事や本を作成する場合、slugはランダムで作成されます。

コンテンツのGitHubリポジトリ管理を行っている場合は、slugを任意に指定できます。

  • 記事の場合はmarkdownファイル名をarticles/[slug].mdという形式にします
  • 本の場合はディレクトリ名をbooks/[:slug]という形式にします

Zenn CLIを使うとファイルの作成時にslugを指定することができます。たとえばwhat-is-slugというslugの記事を作成したい場合は以下のようなコマンドを実行します。

$ npx zenn new:article --slug what-is-slug
# => articles/what-is-slug.md`が作成される

詳しくはZenn CLIを使ったファイルの作成方法をご覧ください。

slug指定時の注意点

  1. slugはサイト全体で(記事や本などのコンテンツの種類ごとに)ユニークにする必要があります。他ユーザーの記事で使用済みのslugも使用できないのでご注意ください。
  2. slugは半角英小文字(a-z)、半角数字(0-9)、ハイフン(-)、アンダースコア(_)の12〜50字の組み合わせにする必要があります。
  3. slugは一度zenn.dev上で作成されたら変更できません(slugを変えると別の投稿として作成されます)。

Discussion