📝

ターミナルで記事を投稿してみた:Git操作の実践記録

に公開

ターミナルで記事を投稿してみた体験記

はじめに

最近、ターミナルとGitを使って技術記事を投稿する方法を学びました。この記事では、その過程で学んだことや、つまずいたポイントを共有したいと思います。

1. 環境構築

必要なツール

  • Git
  • Node.js
  • テキストエディタ
  • ターミナル(PowerShell/コマンドプロンプト)

Zenn CLIのセットアップ

  1. プロジェクトの初期化

    npm init --yes
    
  2. Zenn CLIのインストール

    npm install zenn-cli
    
  3. Zennの初期化

    npx zenn init
    

2. 記事作成のワークフロー

ブランチの作成と切り替え

git checkout -b add-new-article

記事ファイルの作成

  1. Zenn CLIを使用

    npx zenn new:article
    
  2. 手動でMarkdownファイル作成

    • articlesディレクトリに.mdファイルを作成
    • フロントマターの設定

プレビューの確認

npx zenn preview

3. つまずいたポイント

Gitの操作関連

  1. ブランチ名の付け方

    • 機能や目的を明確に
    • 命名規則の統一
  2. コミットメッセージ

    • 変更内容を簡潔に
    • プレフィックスの活用(feat, fix, docs等)
  3. マージの問題

    • コンフリクトの解決
    • リベースとマージの使い分け

ファイル構造の問題

  1. 記事の配置

    • articlesディレクトリに配置
    • ファイル名の規則
  2. 画像の管理

    • imagesディレクトリの活用
    • 相対パスの指定方法

node_modulesの管理

  • .gitignoreの設定
  • パッケージのバージョン管理

4. 学んだこと

効率的な記事作成

  1. テンプレートの活用

    • フロントマターの定型化
    • よく使う記法のスニペット化
  2. バージョン管理の重要性

    • こまめなコミット
    • 変更履歴の追跡

コマンドラインの便利さ

  1. 操作の自動化

    • スクリプトの活用
    • エイリアスの設定
  2. 効率的なファイル操作

    • ディレクトリ移動
    • ファイル作成・編集

5. 改善点と今後の課題

ワークフローの最適化

  • コミットの粒度
  • ブランチ戦略の見直し
  • CIの導入検討

執筆環境の改善

  • エディタの設定
  • プレビュー環境の整備
  • 画像管理の効率化

まとめ

ターミナルを使った記事投稿は、最初は慣れない作業の連続でしたが、以下のメリットを実感できました:

  1. バージョン管理の容易さ
  2. 作業の再現性
  3. 自動化の可能性
  4. コマンドラインスキルの向上

また、この経験を通じて以下の教訓を得ました:

  • 基本的なGit操作の重要性
  • ドキュメント管理の大切さ
  • 効率的なワークフローの構築

これから同じように記事投稿を始める方の参考になれば幸いです。

GitHubで編集を提案

Discussion