Giter VIP home page Giter VIP logo

asciilight's Introduction

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.