ℹ️ Information ℹ️

GitHub is sunsetting Atom on December 15, 2022.
As a result, we recommend migrating to an alternative solution. The Asciidoctor community is now focusing on providing the best writing experience using the IntelliJ platform or Visual Studio Code.

On December 15, 2022, this repository will be archived.

AsciiDoc Preview package

Shows the rendered HTML of the AsciiDoc content in current editor.

Toggle the preview pane, which appears to the right of the editor, by using the key combination ctrl-shift-a or cmd-shift-a.

It is currently enabled for .adoc, .asciidoc, .ad, .asc, .adoc.txt, .txt files.

Note: since 1.0.0, the auto-completions have been migrated to a dedicate package: autocomplete-asciidoc.

This package use Asciidoctor.js.

Options

• Live preview or preview only on save.
• Choose the position of the preview pane: "left", "right", "up", "down" (default: "right")
• Enable or disable table of contents (TOC) in preview pane.
  • Supported TOC positions: default (center), preamble, or macro.
  • Choose none in settings to allow document to control position.
  • If toc attribute is set to left or right, the TOC will appear in the center.
• Save as HTML: save the document to an HTML file.
• Export as PDF: create a PDF file and open with your default PDF viewer.
  • asciidoctor-pdf command must be available on your PATH.
  • more styling options are available in the package settings.
• Synchronize the preview pane: synchronize the preview pane with the AsciiDoc source pane.
  • WARNING: The scroll position on the preview pane does not automatically scroll the AsciiDoc source pane.

More options are available :

• in the package settings
• in the global menu
• by right-clicking on the preview
• by right-clicking on an AsciiDoc file.

Disclaimer About Styles

The preview window is not meant to emulate the published styles. Rather, it's intended to present a preview of the content to assist with editing. This is by design. It also aims to make the best use of limited screen space. So, for example, you won't see functionality such as a sidebar TOC. The colors may also differ to better integrate with the Atom theme. If you want to customize the apparance of the preview, you can specify your own stylesheet in the settings.

Others Atom packages for AsciiDoc

• language-asciidoc: Syntax highlighting and snippets for AsciiDoc (with Asciidoctor flavor).
• asciidoc-preview: Show an preview for the AsciiDoc content in the current editor.
• autocomplete-asciidoc: AsciiDoc language autocompletions.
• asciidoc-image-helper: When pasting an image into an Asciidoc document, this package will paste clipboard image data as a file into a folder specified by the user.
• asciidoc-assistant: install Atom AsciiDoc basic packages with one package.

More

You can install this module from the command-line by typing apm install asciidoc-preview.

Thanks to @kevinsawicki for inspiration markdown-preview.