Asciidoctor Vscode Versions Save

AsciiDoc support for Visual Studio Code using Asciidoctor

v3.1.5

8 months ago

Release meta

Released by: @ggrossetie

Full Changelog: https://github.com/asciidoctor/asciidoctor-vscode/compare/v3.1.4...v3.1.5

v3.1.4

8 months ago

Release meta

Released by: @ggrossetie

Full Changelog: https://github.com/asciidoctor/asciidoctor-vscode/compare/v3.1.3...v3.1.4

v3.1.3

9 months ago

What's Changed

Changelog

Bug fixes

  • Ignore Antora documentation component symlinks (#755)
  • Disable data-uri in preview (not supported) (#756)
  • Provide image completion relative to the imagesdir attribute (#759)
  • Move getContent call after generating the document header (#762)
  • Remove the imagesdir attribute from image paths when drag and dropping images in the editor (#761)

Release meta

Released by: @ggrossetie

Full Changelog: https://github.com/asciidoctor/asciidoctor-vscode/compare/v3.1.2...v3.1.3

v3.1.2

10 months ago

What's Changed

Changelog

Bug fixes

  • Use textDocument.lineAt to avoid issues with line separators discrepancy (#750)
  • Include .asciidoctorconfig, AsciiDoc attributes defined in the extension configuration and Antora AsciiDoc attributes in attributes completion (#754)

Release meta

Released by: @ggrossetie

Full Changelog: https://github.com/asciidoctor/asciidoctor-vscode/compare/v3.1.1...v3.1.2

v3.1.0

10 months ago

What's Changed

This release is a major step forward!

Asciidoctor CLI Dropped 💨

We've decided to remove Asciidoctor CLI support in order to provide a better experience and reduce the maintenance burden. This change has allowed us to restructure the extension and implement new features.

New WebView Converter ✨

One major change is that the preview now generates a complete HTML document that's perfectly suited for a Webview. For instance, we were relying on CDN to provide STEM support (MathJax), icons (FontAwesome) and fonts (Google Fonts) but now everything is included in the extension. The preview will work just as well even if your are offline! Another benefit is that we can implement a custom logic on how external resources are resolved. The AsciiDoc extension should now seamlessly resolve stylesheets from an URL or a local path.

Code Folding 📂

This version also introduces support for code folding on sections, conditional blocks, open blocks and comments:

Custom Extensions 🔌

Extensions are central to the success of AsciiDoc because they open up the language to new use cases. This new release allows to register and load custom Asciidoctor.js extensions from the .asciidoctor/lib directory. Here's an example using the Asciidoctor Emoji extension:

Refined Settings 🎛️

Settings are now organized by section (Preview, PDF, Extensions, General, Debug) and we applied a naming convention to make sure that every setting name is consistent.

As a result, we've deprecated a few settings. If you are using a deprecated setting, a deprecation message will show and help you to migrate:

We took the opportunity to make a few enhancements. For instance, you can now configure a list of command line arguments for wkhtmltopdf:

As you can see on the screenshot above, we are also using Markdown description to improve readability.

PDF Export 🖨️

To make it easier to get started, the VS Code extension will offer to install Asciidoctor PDF if asciidoctor-pdf is not available on your PATH but bundle is!

Regarding wkhtmltopdf, since we were using an outdated version, we've removed the option to install it. Instead, we recommend to download and install the latest version from https://wkhtmltopdf.org/downloads.html

Internationalization 🌐

The VS Code extension is now also available in French 🇫🇷 and Japanese 🇯🇵 (thanks to @YoshihideShirai)

Community 🫂

Last but not least, this release includes contributions from 6 new contributors and quite a few bug fixes!

Breaking changes

NOTE: If you want to keep using asciidoctor CLI, it's possible to setup a similar workflow using both the HTML Preview and Run on Save extensions using the following settings.json:

{
    "emeraldwalk.runonsave": {
        "commands": [
            {
                "match": "\\.adoc$",
                "cmd": "asciidoctor ${file}"
            },
        ]
    }
}

You can also setup a workflow outside of VS Code that relies on the asciidoctor CLI.

  • pdf-themesdir is now relative to the working directory (i.e., workspace folder) not relative to the document (#703)
  • stylesdir and stylesheet attributes are now ignored in the preview. Instead, you should define asciidoc.preview.style. Please note that when exporting to HTML, stylesdir and stylesheet will be used and should be defined in an .asciidoctorconfig file.

NOTE: We strongly recommend to use .asciidoctorconfig file to define common attributes. This file will be used in the preview and when exporting to HTML and PDF (using asciidoctor-pdf).

  • asciidoc.extensions.enableKroki is now disabled by default. If you are using diagrams you will need to enable this setting explicitly.

Improvements

Bug fixes

Infrastructure

Documentation

New Contributors

Full Changelog: https://github.com/asciidoctor/asciidoctor-vscode/compare/v2.9.8...v3.1.0

v3.0.6

11 months ago

What's Changed

Changelog

Improvements

  • provide folding for list of sibling attributes by @apupier (#719)

Bug fixes

  • folding of several single line comments is not working for more than 2 lines (#722)

Release meta

Released by: @ggrossetie

Full Changelog: https://github.com/asciidoctor/asciidoctor-vscode/compare/v3.0.5...v3.0.6

v3.0.5

11 months ago

What's Changed

Changelog

Breaking changes

  • use vscode fs api instead of Node fs by @apupier in https://github.com/asciidoctor/asciidoctor-vscode/pull/669
  • pdf-themesdir is now relative to the working directory (i.e., workspace folder) not relative to the document (#703)
  • remove Asciidoctor CLI support (#539)
  • stylesdir and stylesheet attributes are now ignored in the preview. Instead, you should define asciidoc.preview.style. Please note that when exporting to HTML, stylesdir and stylesheet will be used and should be defined in an .asciidoctorconfig file.

NOTE: We strongly recommend to use .asciidoctorconfig file to define common attributes. This file will be used in the preview and when exporting to HTML and PDF (using asciidoctor-pdf).

Improvements

Bug fixes

New Contributors

Release meta

Released by: @ggrossetie

Full Changelog: https://github.com/asciidoctor/asciidoctor-vscode/compare/v3.0.4...v3.0.5

v3.0.3

1 year ago

What's Changed

Changelog

Bug fixes

  • declare supports_templates as attribute otherwise backendTraits overrides other values, as a result syntax highlighting wasn't working anymore! (#666)

Release meta

Released by: @Mogztter

Full Changelog: https://github.com/asciidoctor/asciidoctor-vscode/compare/v3.0.2...v3.0.3

v3.0.2

1 year ago

What's Changed

Changelog

Improvements

Bug fixes

  • fix the logic that detects if asciidoctor-pdf and/or bundler are available in the PATH
  • fix base directory when exporting to PDF on Windows (#593)
  • fix localization generation by @YoshihideShirai (#594)
  • fix Table Of Content sidebar color not aligned with the active theme by @apupier (#340)
  • fix typo Recomendations -> Recommendations in snippets by @apupier

Infrastructure

Documentation

New Contributors

Release meta

Released by: @Mogztter

Full Changelog: https://github.com/asciidoctor/asciidoctor-vscode/compare/v3.0.1...v3.0.2

v3.0.1

1 year ago

What's Changed

This is a bug fixes release following 3.0.0 release.

Changelog

Bug fixes

  • fix the logic that detects if asciidoctor-pdf and/or bundler are available in the PATH
  • fix base directory when exporting to PDF on Windows (#593)
  • fix localization generation by @YoshihideShirai (#594)
  • fix typo Recomendations -> Recommendations in snippets by @apupier

Release meta

Released by: @Mogztter

Full Changelog: https://github.com/asciidoctor/asciidoctor-vscode/compare/v3.0.0...v3.0.1