🎉

Zennの記事をGitHubで作成するときのTips

2023/03/18に公開

はじめに

ZennをGitHubに連携すると、GitHubリポジトリから記事を作成する必要がある。
初めての記事作成時に手間取ったので関連情報をここにまとめる。

「github.dev Webベースエディター」へアクセス

  1. GitHubリポジトリのZenn用のフォルダ?へアクセスする。
    例:https://github.com/GoatEatAny/zenn

  2. ブラウザ上部のURLを「github.com」から「github.dev」へ変更する。
    例:https://github.dev/GoatEatAny/zenn

  3. すると、Webベースエディターへアクセスが表示される。ここで記事のファイルを作成/編集、画像のアップロードをする。

image1
Webベースエディター画面例

VSCode 拡張機能のインストール

便利なので入れておくこと。
下記サイトを参考に、Zennの編集画面プレビューがリアルタイムで確認可能な拡張機能をインストールする。

https://zenn.dev/zenn/articles/usage-github-dev#vscode-拡張のインストール

拡張機能の使い方は下記サイトに記載されている。

https://marketplace.visualstudio.com/items?itemName=zenn.zenn-preview#:~:text=表示します-,使い方,-Zenn のコンテンツ

記事の作成/編集

下記サイトの手順で記事を新規作成できる。

https://marketplace.visualstudio.com/items?itemName=zenn.zenn-preview#:~:text=されます。-,コンテンツの新規作成,-ツリービュー内の

が、詰まった部分があったので記載する。
手順通り新規作成後、一度エディター画面左のソース管理から「コミットとプッシュ」をしないと拡張機能のプレビュー画面にプレビューが表示されない。

image2
プレビューが表示されない画面例

Tips: Markdown記法や画像のアップロード方法

下記サイトでMarkdown記法や画像のアップロード方法が紹介されている。

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

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

Discussion