https://github.com/pwright/pview
A preview script for pantheon
https://github.com/pwright/pview
Last synced: 4 months ago
JSON representation
A preview script for pantheon
- Host: GitHub
- URL: https://github.com/pwright/pview
- Owner: pwright
- License: mit
- Created: 2021-05-21T14:07:10.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-09-10T13:14:42.000Z (almost 5 years ago)
- Last Synced: 2025-10-21T11:52:33.685Z (8 months ago)
- Language: Haml
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pview
A script for [Pantheon 2](https://github.com/redhataccess/pantheon) styled AsciiDoc previews.
Use in addition to `asciidoctor` for previewing your files.
```
npm i -g @techwriter/pview
pview
```
Note: `pview` does not inspect your files for validity. Files that are invalid for [Pantheon 2](https://github.com/redhataccess/pantheon) convert without errors. Use this script to validate table and source code layout, see [pantheon-cmd](https://github.com/redhataccess/pantheon-cmd) for a convertor that checks for Pantheon 2 correctness.
**Prerequisites**
Before installing this, make sure your system is capable of running HAML templates:
```
gem install --user tilt
gem install --user coderay
gem install --user haml
```
Optionally, install concurrent-ruby.
You can create pantheon html from anywhere on your system, using any valid asciidoctor options:
```
pview
```
For example:
```
pview -a data-uri -a allow-uri-read my-document.adoc
```
produces an HTML document with embedded images.
Note that this creates a HTML file that you probably want to delete after previewing.