Skip to content
This repository was archived by the owner on Mar 1, 2025. It is now read-only.

Commit 89d4b4f

Browse files
committed
offer emacs documentation properly on vuepress
1 parent e6f41d9 commit 89d4b4f

File tree

2 files changed

+26
-6
lines changed

2 files changed

+26
-6
lines changed

.vuepress/config.ts

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,11 @@ export default defineUserConfig({
6565
{ text: 'Contribute', link: '/contributing.html' },
6666
{ text: 'Code of Conduct', link: '/coc.html' },
6767
{ text: 'FAQ', link: '/faq.html' },
68+
{
69+
text: 'Guides', children: [
70+
{ text: 'Emacs', link: '/guides/emacs.html' }
71+
]
72+
},
6873
{
6974
text: 'Legacy', children: [
7075
{ text: 'Beta Release Manual', link: '/legacy/beta-rel-man.html' },
@@ -105,6 +110,11 @@ export default defineUserConfig({
105110
{ text: '贡献(只限英文)', link: '/contributing.html' },
106111
{ text: '行为准则(只限英文)', link: '/coc.html' },
107112
{ text: '常见问题', link: '/zh-CN/faq.html' },
113+
{
114+
text: '指南', children: [
115+
{ text: 'Emacs', link: '/guides/emacs.html' }
116+
]
117+
},
108118
{
109119
text: '旧文档(只限英文)', children: [
110120
{ text: 'Beta Release Manual', link: '/legacy/beta-rel-man.html' },
@@ -145,6 +155,11 @@ export default defineUserConfig({
145155
{ text: '貢獻(只限英文)', link: '/contributing.html' },
146156
{ text: '行為守則(只限英文)', link: '/coc.html' },
147157
{ text: '常見問題', link: '/zh-TW/faq.html' },
158+
{
159+
text: '指南', children: [
160+
{ text: 'Emacs', link: '/guides/emacs.html' }
161+
]
162+
},
148163
{
149164
text: '舊文檔(只限英文)', children: [
150165
{ text: 'Beta Release Manual', link: '/legacy/beta-rel-man.html' },
@@ -184,6 +199,11 @@ export default defineUserConfig({
184199
{ text: 'Kontribuanto (Nur la Angla)', link: '/contributing.html' },
185200
{ text: 'Kondutkodo (Nur la Angla)', link: '/coc.html' },
186201
{ text: 'Oftaj Demandoj', link: '/eo/faq.html' },
202+
{
203+
text: 'Enkondukoj', children: [
204+
{ text: 'Emacs', link: '/guides/emacs.html' }
205+
]
206+
},
187207
{
188208
text: 'Heredaĵo (Nur la Angla)', children: [
189209
{ text: 'Beta Release Manual', link: '/legacy/beta-rel-man.html' },

emacs.org renamed to guides/emacs.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
#+title: Emacs
1+
# Emacs Integration
22

33
Emacs' built in file manager Dired is often used to browse files. And Emacs is often used in WSL on Windows, because the windows-native GNU Emacs is kind of meh.
44
But sadly some typical files we have to deal with on windows are files Emacs can't handle very well. (Mostly MS Office files)
55

6-
To use Emacs' Dired in WSL Emacs to open files in Windows, the ~wslview~ command from Wslutilities can be used.
6+
To use Emacs' Dired in WSL Emacs to open files in Windows, the `wslview` command from Wslutilities can be used.
77

88
Put this in init.el:
9-
#+begin_src emacs-lisp
9+
```emacs-lisp
1010
(defun my/wslview-open(&optional @fname)
1111
"Use wslview to open file in Windows."
1212
(interactive)
@@ -27,8 +27,8 @@ Put this in init.el:
2727
(concat "wslview " (shell-quote-argument $fpath)))) $file-list)
2828
(when (not (string-equal major-mode "dired-mode"))
2929
(revert-buffer)))))
30-
#+end_src
30+
```
3131

32-
Now, when you mark files in Dired using ~m~ (or if nothing is marked, the file under point is used) run ~M-x my/wslview-open~ to open the marked files using whatever is the appropriate program in Windows.
32+
Now, when you mark files in Dired using `m` (or if nothing is marked, the file under point is used) run `M-x my/wslview-open` to open the marked files using whatever is the appropriate program in Windows.
3333
If more then five files where marked, Emacs will prompt in the minibuffer if that many files should really be opened.
34-
Also, if you are not in a Dired buffer and you run ~M-x my/wslview-open~, the file of the currently open buffer will be opened with the appropriate program in Windows.
34+
Also, if you are not in a Dired buffer and you run `M-x my/wslview-open`, the file of the currently open buffer will be opened with the appropriate program in Windows.

0 commit comments

Comments
 (0)