首页
/ vim-instant-markdown 项目教程

vim-instant-markdown 项目教程

2024-10-10 12:07:42作者:裘晴惠Vivianne

1. 项目的目录结构及介绍

vim-instant-markdown/
├── AUTHORS.md
├── CHANGELOG.md
├── LICENSE
├── README.md
├── doc/
│   └── vim-instant-markdown.txt
├── ftplugin/
│   └── markdown/
│       └── instant-markdown.vim
├── package.json
└── vimrc

目录结构介绍

  • AUTHORS.md: 项目贡献者列表。
  • CHANGELOG.md: 项目更新日志。
  • LICENSE: 项目许可证文件。
  • README.md: 项目介绍和使用说明。
  • doc/: 包含项目的帮助文档。
    • vim-instant-markdown.txt: Vim 帮助文档。
  • ftplugin/: 包含文件类型插件。
    • markdown/: Markdown 文件类型的插件目录。
      • instant-markdown.vim: 主要插件文件,用于实时预览 Markdown 文件。
  • package.json: Node.js 项目的配置文件,包含依赖项和脚本。
  • vimrc: Vim 配置文件示例。

2. 项目的启动文件介绍

项目的启动文件是 ftplugin/markdown/instant-markdown.vim。这个文件是 Vim 插件的核心部分,负责在 Vim 中打开 Markdown 文件时启动实时预览功能。

启动文件介绍

  • instant-markdown.vim:
    • 该文件定义了 Vim 插件的主要功能,包括启动和停止 Markdown 实时预览。
    • 它通过调用 Node.js 或 Python 的 mini-server 来实现实时预览功能。
    • 当用户在 Vim 中打开一个 Markdown 文件时,该插件会自动启动一个浏览器窗口,显示 Markdown 文件的实时预览。

3. 项目的配置文件介绍

项目的配置文件主要包括 vimrcpackage.json

配置文件介绍

  • vimrc:

    • 这是一个示例 Vim 配置文件,用户可以根据需要将其内容添加到自己的 .vimrc 文件中。
    • 配置文件中包含了插件的加载方式和一些可选的配置选项,如 g:instant_markdown_slowg:instant_markdown_autostart 等。
  • package.json:

    • 这是 Node.js 项目的配置文件,包含了项目的依赖项和脚本。
    • 用户可以通过运行 npm installyarn install 来安装项目所需的依赖项。

配置选项

以下是一些常用的配置选项:

" 启用文件类型插件
filetype plugin on

" 以下是一些可选的配置选项
" 设置实时预览的延迟时间
let g:instant_markdown_slow = 1

" 禁用自动启动实时预览
let g:instant_markdown_autostart = 0

" 允许外部访问实时预览
let g:instant_markdown_open_to_the_world = 1

" 允许不安全的内容
let g:instant_markdown_allow_unsafe_content = 1

" 允许外部内容
let g:instant_markdown_allow_external_content = 0

" 启用 MathJax 支持
let g:instant_markdown_mathjax = 1

" 启用 Mermaid 支持
let g:instant_markdown_mermaid = 1

" 设置日志文件路径
let g:instant_markdown_logfile = '/tmp/instant_markdown.log'

" 禁用自动滚动
let g:instant_markdown_autoscroll = 0

" 设置端口号
let g:instant_markdown_port = 8888

" 使用 Python mini-server
let g:instant_markdown_python = 1

" 设置主题
let g:instant_markdown_theme = 'dark'

通过这些配置选项,用户可以根据自己的需求定制插件的行为。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
861
511
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
259
300
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
596
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K