All Projects → asciidoctor → Atom Asciidoc Preview

asciidoctor / Atom Asciidoc Preview

Licence: mit
⚛ AsciiDoc preview for the Atom editor.

Programming Languages

coffeescript
4710 projects

Projects that are alternatives of or similar to Atom Asciidoc Preview

asciidoctor-lein-plugin
A Leiningen plugin for generating documentation using Asciidoctor
Stars: ✭ 26 (-80.88%)
Mutual labels:  asciidoc, asciidoctor
Asciidoctor
💎 A fast, open source text processor and publishing toolchain, written in Ruby, for converting AsciiDoc content to HTML 5, DocBook 5, and other formats.
Stars: ✭ 3,905 (+2771.32%)
Mutual labels:  asciidoc, asciidoctor
Gradle Multi Project Example
Gradle 多项目管理示例
Stars: ✭ 283 (+108.09%)
Mutual labels:  asciidoc, asciidoctor
AsciiDocQuickLook
A QuickLook plugin to preview AsciiDoc files.
Stars: ✭ 24 (-82.35%)
Mutual labels:  asciidoc, asciidoctor
Asciidoctor Html5s
Semantic HTML5 converter (backend) for Asciidoctor
Stars: ✭ 50 (-63.24%)
Mutual labels:  asciidoc, asciidoctor
middleman-asciidoc
🔰 AsciiDoc support for Middleman 4. (In Middleman 3, AsciiDoc support is provided by a core extension).
Stars: ✭ 24 (-82.35%)
Mutual labels:  asciidoc, asciidoctor
Doctoolchain
a Gradle based AsciiDoc Toolchain for Software Architecture Documentation
Stars: ✭ 355 (+161.03%)
Mutual labels:  asciidoc, asciidoctor
asciidoctor-htmlbook
Asciidoctor HTMLBook is an Asciidoctor backend for converting AsciiDoc documents to HTMLBook documents.
Stars: ✭ 31 (-77.21%)
Mutual labels:  asciidoc, asciidoctor
Asciidoctor Pdf
📃 Asciidoctor PDF: A native PDF converter for AsciiDoc based on Asciidoctor and Prawn, written entirely in Ruby.
Stars: ✭ 868 (+538.24%)
Mutual labels:  asciidoc, asciidoctor
Asciidoc Kate
AsciiDoc/AsciiDoctor syntax highlighting plugin for Kate editor/KatePart
Stars: ✭ 5 (-96.32%)
Mutual labels:  asciidoc, asciidoctor
asciidoctor-rfc
AsciiRFC: an AsciiDoc/asciidoctor backend to produce RFC XML v3 (RFC 7991) and v2 (RFC 7749)
Stars: ✭ 14 (-89.71%)
Mutual labels:  asciidoc, asciidoctor
Kramdown Asciidoc
A kramdown extension for converting Markdown documents to AsciiDoc.
Stars: ✭ 97 (-28.68%)
Mutual labels:  asciidoc, asciidoctor
mup
A markup previewer
Stars: ✭ 38 (-72.06%)
Mutual labels:  asciidoc, preview
bitbucket-asciidoc-plugin
An add-on for Atlassian Bitbucket Server to render AsciiDoc files.
Stars: ✭ 20 (-85.29%)
Mutual labels:  asciidoc, asciidoctor
eclipse-asciidoctor-editor
An eclipse editor for asciidoctor files
Stars: ✭ 45 (-66.91%)
Mutual labels:  asciidoc, asciidoctor
Md Writer
✒️ Make Atom a better Markdown/AsciiDoc editor for writers and bloggers
Stars: ✭ 326 (+139.71%)
Mutual labels:  atom, asciidoc
Asciidoctor Intellij Plugin
AsciiDoc plugin for products on the IntelliJ platform (IDEA, RubyMine, etc)
Stars: ✭ 250 (+83.82%)
Mutual labels:  asciidoc, asciidoctor
asciidoctor-katex
Asciidoctor extension for converting latexmath using KaTeX at build time
Stars: ✭ 16 (-88.24%)
Mutual labels:  asciidoc, asciidoctor
Asciidoctor.js
A JavaScript port of Asciidoctor, a modern implementation of AsciiDoc
Stars: ✭ 500 (+267.65%)
Mutual labels:  asciidoc, asciidoctor
Atom Latex
The only LaTeX package you need for typesetting with Atom.
Stars: ✭ 60 (-55.88%)
Mutual labels:  atom, preview

AsciiDoc Preview package

Atom Package Atom Package Downloads Build Status (Linux) Build Status (Windows) MIT License

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.

asciidoc-preview

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.

AsciiDoc Preview demo

Thanks to @kevinsawicki for inspiration markdown-preview.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].