Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shuntaka9576/preview-asciidoc.nvim
:memo: preview asciidoc in real time!
https://github.com/shuntaka9576/preview-asciidoc.nvim
Last synced: 3 months ago
JSON representation
:memo: preview asciidoc in real time!
- Host: GitHub
- URL: https://github.com/shuntaka9576/preview-asciidoc.nvim
- Owner: shuntaka9576
- License: mit
- Archived: true
- Created: 2020-01-02T14:44:06.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-07T06:33:45.000Z (about 1 year ago)
- Last Synced: 2024-06-28T07:37:28.064Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 291 KB
- Stars: 15
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
⚠️This repository is no longer maintenance. Please use [preview-asciidoc.vim](https://github.com/shuntaka9576/preview-asciidoc.vim) instead.⚠️
# preview-asciidoc.nvim
It is possible to preview with [Asciidoctor](https://asciidoctor.org/docs/user-manual/) in real time!
## Features
* [x] Excute the :AsciidocPreview preview asciidoc in real time
* [ ] AutoScroll
## Requirements
* Neovim
* Node.js("node" command in $PATH)
* asciidoctor("asciidoctor" command in $PATH)
* asciidoctor-diagram
## Install & Usage
install with [dein](https://github.com/Shougo/dein.vim.git)
```vim
" .vim config
call dein#add('shuntaka9576/preview-asciidoc.nvim', { 'build': 'yarn install', 'merged': 0 } )
```
```toml
# .toml config
[[plugins]]
repo = 'shuntaka9576/preview-asciidoc.nvim'
build = 'yarn install'
merged = 0
```
usage
```
:AsciiDocPreview
```
## Config
```vim
" set to node path
" default "node" command in $PATH
let g:padoc_node_path = '~/.anyenv/envs/nodenv/shims/node'
" set to lunch port
" default 9136
let g:padoc_lunch_port='6060'
" set asciidoc build command
" deafult `asciidoctor -r asciidoctor-diagram`
let g:padoc_build_command = 'asciidoctor -r asciidoctor-diagram'
" [experimental] auto scroll settings
let g:padoc_experimental_auto_scroll=1
```
## Contribution
```
export NVIM_PADOC_LOG_LEVEL=debug
export NVIM_PADOC_LOG_FILE=/tmp/padoc.log
yarn install
```