帮助:使用VSCode协助编辑条目
From Limbo Wiki
Visual Studio Code(以下简称VS Code)是由微软发行的开源代码编辑器,拥有丰富的扩展功能。
搭配使用由Rowe Wilson Frederisk Holme开发的Wikitext扩展并接入林百的API可以方便地实现代码着色、补全与实时预览功能,提高页面的编辑效率。
安装VS Code
下载
访问VS Code官方网站,官网会自动检测正在使用的操作系统,只需要点击左侧的下载按钮即可。 如果对系统的检测有误或者需要为其他操作系统安装,可以从下载按钮右侧的下拉列表选择,或者点击右上角的Download查看更多支持的版本。
安装
- Windows:运行安装包后按需选择安装。
- macOS:解压后直接运行。
汉化
VS Code默认语言为英语,第一次启动时会在右下角自动提示安装汉化包。
如果没有相关提示,可点击左侧扩展(Extensions)图标,或者按下Ctrl
+⇧ Shift
+X
,搜索“Chinese”,选择“Chinese (Simplified) (简体中文) Language Pack for Visual Studio Code”并点击“安装(Install)”。安装完成后会提示重启,重启后即可显示为中文界面。
安装与配置Wikitext扩展
创建工作区
- 创建一个新的文件夹用于保存您的Wikitext文件;
- 启动VS Code,点击“文件”→“打开文件夹”并打开刚创建的文件夹;
- 如果弹出是否信任此文件夹中的文件的作者?,必须要选择“是,我信任此作者”,否则将无法使用扩展功能。
- 点击“文件”→“将工作区另存为”将工作区保存下来;
- 下次启动时用VS Code打开工作区文件,或者点击“文件”→“Open Workspace from File…”即可进入工作区。
安装扩展
- 打开左侧扩展面板,搜索“Wikitext”并安装;
- 安装完成后在扩展面板的“已安装”一栏下找到“Wikitext”,点击右下角的小齿轮,先选择“禁用”,然后选择“启用(工作区)”。这一步的目的是将扩展限制在工作区内,以避免编辑其他类型文件时产生潜在的冲突和性能问题;
- 在工作区内新建扩展名为“.wikitext”的文件,并输入一段Wikitext进行测试。如果代码能够正常高亮,则表示扩展可用,安装没有问题。
配置扩展并接入林百API
如果需要使用到扩展的预览功能,则需要接入林泊百科的API。
林百的API地址:https://wiki.pigeon-games.com/api.php
- 以下为Wikitext扩展的配置方法:
- 点击VS Code左下角的齿轮,选择“设置”,打开设置界面;
- 在左侧的目录中找到“扩展”→“Wikitext”或直接在搜索框中输入
@ext:rowewilsonfrederiskholme.wikitext
; - 按照下表进行设置:
名称 | 值 | 解释 |
---|---|---|
Api Path | /api.php | 林泊百科API地址。 |
Article Path | /index.php?title=$1 | 林泊百科页面地址。 |
Enable JavaScript | 按需开启 | 启用预览时对JS的支持。 |
Get CSS | 开启 | 启用预览时对CSS的支持。用作页面的样式设计。 |
Preview CSS Style | 默认即可 | 设置预览时的默认样式表。 |
Host | wiki.pigeon-games.com | 主站地址。 |
Password | [密码] | 用户密码。 |
User Name | [用户名] | 用户名。 |
设置完成后,可输入一段wikitext,然后点击右上角的预览按钮,或按Ctrl
+Shift
+V
预览,如果配置正确,将会在右边看到条目的显示效果。
使用Wikitext扩展
- 在VS Code中按下F1并搜索“Wikitext”即可看到所有支持的指令。目前扩展支持的指令如下:
- Wikitext: View the page
- 查看指定标题的页面。
- Wikitext: Login with your account
- 如果设置好了用户名和密码,此功能可用来登录您的账户。
- Wikitext: Logout, if you are already logged in
- 登出已经登录的账户。
- Wikitext: Pull page to edit
- 提取指定标题的源码以供编辑。
- Wikitext: Post your edit to the website
- 将编辑器的源码提交到指定标题的页面中。请注意,此功能会覆盖整个页面的源码,在提交前请务必确定编辑器内的源码是完整的,否则可能会对页面造成破坏。可以考虑将源码手动复制提交到网页上。