{"repo":"waicode/zenn-content-boilerplate","free":true,"listed":false,"github":"https://github.com/waicode/zenn-content-boilerplate","clone":"git clone https://github.com/waicode/zenn-content-boilerplate.git","description":"🐣 Boilerplate of Zenn writing environment written in Dev Container","language":"Dockerfile","stars":11,"topics":["cspell","devcontainer","docker","husky","lint-staged","markdownlint","textlint","vscode","zenn","zenn-cli"],"license":null,"category":"deployment-docker-iac","readme_excerpt":"zenn-content-boilerplate VSCodeとDocker（devcontainer）で書く Zenn執筆環境のボイラープレート です。このテンプレートを複製すれば、すぐにローカルのPC環境で記事を書きはじめることができます。 Zennの執筆に便利なVSCode拡張機能やスニペットが自動的にインストールされます。 VSCodeの見た目はZennのテーマカラーに合わせています。 zenn-cli を使ってローカル環境でプレビューを確認しながら記事を書くことができます。 記事作成をはじめzenn-cliコマンドはnpmスクリプトに登録済でVSCodeから1クリックで実行できます。 記事の内容は markdownlint , textlint でマークダウンの静的解析（lint）を行います。 英単語の誤字がないか cspell （Code Spell Checker）でチェックをします。 husky と lint-staged でコミット時に自動でlintします。不正な形式の文章はコミットされません。 前提 記事を編集するエディタはVSCode（Visual Studio Code）を使うことが前提です。Zennの執筆に最適化されたVSCodeの拡張機能やスニペットを設定しています。 また、Dockerで専用コンテナを準備して環境をつくります。そのため、ローカル環境にDockerのインストールが必要です。特にこだわりが無ければ、GUIで簡単にDockerコンテナを導入できるDocker Desktopが（個人利用であれば）無料で使えて便利です。 VSCodeからコンテナにアクセスして執筆するためDev ContainersのVSCode拡張機能も必要です。 利用にあたって、 ローカル環境にVSCodeとDockerが準備されていること を前提としています。 使い方 まずは右上の \"Use this template\" をクリックして、このボイラープレートからリポジトリを複製します。 VSCodeで複製したリポジトリをクローンして \"Reopen in Container\" でコンテナを立ち上げます。 コンテナを立ち上げると docker/Dockerfile の内容に基づきコンテナ環境を構築します。 package.json に書かれたライブラリがインストールされます。また devcontainer.json に書かれた設定によって、VSCode拡張機能がインストールされます。 ローカルのエディタでZennの記事が執筆できる zenn-cli もインストールされます。Zenn公式が書いている以下の記事を参考に、GitHubリポジトリと連携してください。 😸 GitHubリポジトリでZennのコンテンツを管理する ここまでの手順でZennの記事を書き始める準備が整いました。 zenn-cli を使った記事の書き方は、Zenn公式が書いている以下の記事に詳しく書かれています。参考にしてください。 🔨 Zenn CLIで記事・本を管理する方法 記事を書く際は、 Zennに最適化されたVSCode拡張機能やスニペットを使う と便利です。また、 コミット時に静的解析（lint）が実行 されます。文章が不正な場合、警告メッセージが表示されてコミットできません。 詳しい設定について、後述していきます。 設定内容 書くための設定 Zenn CLIのコマンドはnpmスクリプトで 記事のプレビュー（ npx zenn preview ）や記事の新規作","default_branch":null,"files":null,"tree":[],"storefront":"/r/waicode","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/waicode/zenn-content-boilerplate/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}