35
Kisaragi Hiu / dired-show-readme · GitLab
source link: https://gitlab.com/kisaragi-hiu/dired-show-readme
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
dired-show-readme
Display README in a directory if it exists, like Github or Nextcloud.
1.0 todos
- Customize separator
- Refresh content with revert-buffer
- Global minor mode
- Actually insert into buffer to fix scrolling and allow copying text or visiting links
Install
With straight.el:
(straight-use-package
'(dired-show-readme
:host gitlab
:repo "kisaragi-hiu/dired-show-readme"))
(add-hook 'dired-mode-hook #'dired-show-readme-mode)Using leaf:
(leaf dired-show-readme
:straight (dired-show-readme :host gitlab :repo "kisaragi-hiu/dired-show-readme")
:config
(add-hook 'dired-mode-hook #'dired-show-readme-mode))Configuration
-
dired-show-readme-pandoc-executable: Path to Pandoc, used to format the README -
dired-show-readme-position:toporbottom; where the README is displayed.
License
GPL v3.
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK