sankantsu / telescope-zenn.nvim

Zenn の記事執筆を支援する telescope.nvim の拡張

telescope-zenn.nvim

telescope-zenn.nvim は、Zenn の記事執筆を支援するための telescope.nvim の拡張です。

Feature

• Slug と同時に記事タイトルを確認および対話的に検索しながら編集する記事を選択できます。
  • topics の文字列も検索対象となります。

Install

• packer.nvim

use {
  "sankantsu/telescope-zenn.nvim", requires = { { "nvim-telescope/telescope.nvim" } }
}

• lazy.nvim

require("lazy").setup({
  { "sankantsu/telescope-zenn.nvim", dependencies = { "nvim-telescope/telescope.nvim", } },
})

Command, Keymap

• :Telescope zenn article_picker: 記事選択画面を起動します。

キーマップ設定例

vim.keymap.set('n', '<leader>fz', telescope.extensions.zenn.article_picker)

⚠️注意点

• Zenn と Github 連携しているレポジトリ内のルートディレクトリで nvim を起動することが必要です。
  • 記事候補の作成に zenn-cli の機能を用いており、zenn-cli がプロジェクトのルートディレクトリ以外で期待する出力を返さないことによる制約です。

Actions

Zenn のプロジェクト内のファイル操作を行うためのカスタムアクションを定義しています。

name	description	default mapping (normal mode)
create	新規記事を作成	c
delete	記事を削除	d

Optional settings

Slug の表示幅を設定するオプションを用意しています。以下は、デフォルト相当の設定の記述方法

require("telescope").setup({
  extensions = {
    zenn = {
      slug_display_length = 7,
    },
  },
})

License

This software is released under the MIT License, see LICENSE.