Dired Sidebar 使用教程

Dired Sidebar 使用教程

dired-sidebar Sidebar for Emacs leveraging Dired 项目地址: https://gitcode.com/gh_mirrors/di/dired-sidebar

1. 项目目录结构及介绍

Dired Sidebar 是一个为 Emacs 编辑器开发的侧边栏插件，它基于 Dired 功能提供了一个快速的文件浏览器。项目的主要目录结构如下：

dired-sidebar/
├── screenshots/             # 截图目录
├── test/                    # 测试文件目录
├── .gitignore               # Git 忽略文件
├── .travis.yml              # Travis CI 配置文件
├── Cask                     # Cask 包管理配置文件
├── LICENSE                  # 项目许可证文件
├── Makefile                 # Makefile 文件，用于构建和测试项目
├── dired-sidebar.el         # 主插件文件
├── readme.org               # 项目说明文件（Org 模式）

• screenshots/：存放项目界面截图的文件夹。
• test/：包含单元测试和测试相关文件的目录。
• .gitignore：定义 Git 应该忽略的文件和目录。
• .travis.yml：配置 Travis CI 自动化构建的文件。
• Cask：Emacs Lisp 的包管理工具 Cask 的配置文件。
• LICENSE：项目使用的许可证信息，本项目采用 GPL-3.0 许可证。
• Makefile：包含构建和测试项目命令的文件。
• dired-sidebar.el：Dired Sidebar 的主要源代码文件。
• readme.org：项目的详细说明文件，采用 Org 模式编写。

2. 项目的启动文件介绍

项目的启动主要依赖于 Emacs 的包管理器，如 Melpa 或者手动通过 Git 进行安装。

• 通过 Melpa 启动：

  使用 use-package 来安装和配置 Dired Sidebar：

  (use-package dired-sidebar
    :ensure t
    :commands (dired-sidebar-toggle-sidebar))
  

• 通过 Git 手动启动：

  1. 克隆 Dired Sidebar 仓库：

     git clone https://github.com/jojojames/dired-sidebar.git
     cd dired-sidebar
     

  2. 将仓库路径添加到 Emacs 的加载路径中，并加载 Dired Sidebar：

     (add-to-list 'load-path "path from pwd")
     (require 'dired-sidebar)
     

  3. 使用快捷键 M-x dired-sidebar-toggle-sidebar 打开或关闭侧边栏。

3. 项目的配置文件介绍

Dired Sidebar 的配置可以通过修改 dired-sidebar.el 文件中的 defcustom 变量来完成，或者在 Emacs 的配置文件中添加相应的设置。

以下是一些基本配置示例：

• 绑定快捷键：

  将 dired-sidebar-toggle-sidebar 绑定到快捷键 C-x C-n：

  (use-package dired-sidebar
    :bind (("C-x C-n" . dired-sidebar-toggle-sidebar))
    :ensure t
    :commands (dired-sidebar-toggle-sidebar))
  

• 自动刷新模式：

  当不在远程文件上时，自动开启文件刷新模式：

  (add-hook 'dired-sidebar-mode-hook
            (lambda ()
              (unless (file-remote-p default-directory)
                (auto-revert-mode))))
  

• 侧边栏主题和字体设置：

  设置侧边栏主题为 vscode 并使用自定义字体：

  (setq dired-sidebar-theme 'vscode)
  (setq dired-sidebar-use-custom-font t)
  

这些配置可以根据个人喜好和需求进行调整。详细的配置选项可以在 dired-sidebar.el 文件中查找 defcustom 变量进行自定义设置。

dired-sidebar Sidebar for Emacs leveraging Dired 项目地址: https://gitcode.com/gh_mirrors/di/dired-sidebar