AsciiDoc preview plugin for Light Table
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
css
fonts
images
js
mode
node_modules
src/lt/plugins
.gitignore
LICENSE.md
README.adoc
asciilight.behaviors
asciilight_compiled.js
asciilight_compiled.js.map
plugin.edn
preview.png
project.clj
sample.adoc

README.adoc

AsciiLight

AsciiLight is a simple plugin for displaying a preview of AsciiDoctor documents. It uses the asciidoctor.js npm module for doing most of the hard work.

1. Installation

Install through the LightTable plugin manager.

2. Usage

With your .adoc file open, open the command bar in (ctrl+space/cmd+space) and select AsciiLight: Watch this editor for changes

preview
Figure 1. Preview

4. Limitiations

Probably plenty, a few that springs to mind
  • No source code highlighting (yet)

  • Not really tested with any advanced AsciiDoc features

5. Credits

  • Marco Polos' excellent lt-markdown plugin provided most of the inspiration for the plugin implementation

  • AsciiDoc syntax highlighting is provided by a codemirror mode created by Thaddee Tyl in AsciiDocBox

6. Contributing

Pull requests are most welcome. Please do not include the transpiled files (_compiled) in the PR.

7. History

  • 0.3.0 AsciiDoc conversion in background thread, asciidoc 1.5.3-rc.3 and minor cleanup fixes

  • 0.2.0 AsciiDoc syntax highlighting. Code highlighting using highlight.js

  • 0.1.0 Initial release: Basic features, just to get the ball rolling.

8. License

MIT, same as Light Table. See LICENSE.md for details.