首页
/ 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'

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

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

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
151
1.96 K
kernelkernel
deepin linux kernel
C
22
6
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
988
396
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
193
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
936
554
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
65
524
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0