# asciidoc-preview.vim

**Repository Path**: QMHTMY/asciidoc-preview.vim

## Basic Information

- **Project Name**: asciidoc-preview.vim
- **Description**: vim插件，打开asciidoc文件直接在浏览器查看渲染后文档。
- **Primary Language**: VimL
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-01-24
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

= Asciidoc文档预览插件Vim
:date: '2020-01-24 16:19:14' (农历2019年除夕)
:author: 'Shieber'

ifndef::env-github[:icons: font]
ifdef::env-github[]
:outfilesuffix: .adoc
:caution-caption: :fire:
:important-caption: :exclamation:
:note-caption: :paperclip:
:tip-caption: :bulb:
:warning-caption: :warning:
endef::[]

:uri-license: https://github.com/QMHTMY/asciidoc-preview.vim/blob/master/LICENSE
:uri-readme: https://github.com/QMHTMY/asciidoc-preview.vim/blob/master/README.adoc


TIP: 本项目受到makdown项目 https://github.com/iamcco/markdown-preview.vim[markdown-preview.vim]的启发。

[NOTE]
====
在火狐浏览器显示时，vim关闭页面并不自动关闭。这是因为火狐默认设置中 `dom.allow_scripts_to_close_windows`
是 `false` ，请在地址栏输入 `about:config` 将该选项设置为 `true`。
====

== 兼容系统
* Linux 
* Mac OS
* Windows

== 描述
[link:README.adoc[English]] vim打开 http://asciidoc.org/[asciidoc]文件时直接在系统默认浏览器上预览，asciidoc文件名必须以下列后缀结尾。

[cols="3", options="header"]
.后缀
|===
|1
|2
|3

|*.ad*
|*.asc*
|*.asd*

|*.ascd*
|*.adoc*
|*.asciidoc*  
|===

== 可使用该项目的软件

- [*]  Vim >= 8.0  

== 计划中的功能
. 配置简单
. 可输入Emoji
. 实时渲染刷新
. 可添加本地图片
. 多平台(Macos/Linux/Windows)

== 参考资料
* https://github.com/asciidoctor/asciidoctor.js[asciidoctor.js]
* https://github.com/iamcco/markdown-preview.vim[markdown-preview.vim]
* https://github.com/asciidoctor/asciidoctor-browser-extension[asciidoctor-browser-extension]

== 版权声明
Copyright (C) 2019-2020 Shieber，在 link:LICENSE[APACHE LICENSE]下开源。