v3.1.6

Release meta

Released by: @ggrossetie

Full Changelog: v3.1.5...v3.1.6

v3.1.5

Release meta

Released by: @ggrossetie

Full Changelog: v3.1.4...v3.1.5

v3.1.4

Release meta

Released by: @ggrossetie

Full Changelog: v3.1.3...v3.1.4

v3.1.3

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: v3.1.2...v3.1.3

v3.1.2

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: v3.1.1...v3.1.2

v3.1.0

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

• remove Asciidoctor CLI support (#539)

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

• add Japanese localisation by @YoshihideShirai (#581)
• register Asciidoctor.js extensions by @YoshihideShirai (#569)
• create a complete HTML document using the WebView converter by @Mogztter (#547)
• add code folding based on sections by @marieflorescontact (#550)
• add code folding on conditionals by @marieflorescontact (#555)
• add code folding on open blocks by @marieflorescontact (#559)
• add code folding on comment blocks by @marieflorescontact (#561)
• add code folding on single line comment by @marieflorescontact (#565)
• update preview icons and use codicons by @Mogztter (#54)
• use load instead of convert for performance by @Mogztter (#542)
• normalize setting names and group settings by category by @Mogztter (#577)
• do not offer to download an outdated version of wkhtmltopdf anymore by @Mogztter (#577)
• add a new setting to add command line arguments for wkhtmltopdf by @Mogztter (#577)
• offer to install the latest version of asciidoctor-pdf by @Mogztter (#577)
• support .asciidoctorconfig and .asciidoctorconfig.adoc by @apupier, @mogztter and @ahus1 (#380)
• initial support for Antora by @marieflorescontact
• resolve Antora resources IDs on images by @marieflorescontact in #614
• add an option to preserve the preview window to avoid refreshing when switching away, and added setting to control this behavior by @rben01 in #607
• simplify contributions and add editor-selection style
• add support for custom templates by @xdavidson in #616
• provide sorttext on include suggestions by @eiswind in #626
• search path for included files by @eiswind in #618
• add drop images into editor feature by @marieflorescontact in #627
• set env attribute to vscode by @Mogztter in #644
• open xref from preview by @Mogztter in #643
• Include path to completion item for xref by @apupier in #671
• add ability for asciidocParser to pass the krokiServerUrl by @haydencbarnes in #701
• provide completion short hand and long hand notation with similar scope of legacy by @apupier in #668
• append AsciiDoc attributes defined in antora.yml by @ggrossetie in #694
• add UI message with Japanese locale by @YoshihideShirai in #689
• support non-Git workspace by @ggrossetie in #696
• provide completion after<<from same document by @apupier in #670
• Fix completion after xref: for old double-square bracket notation by @apupier in #667
• provide folding for list of sibling attributes by @apupier (#719)

Bug fixes

• set basebackend and outfilesuffix on the WebView converter otherwise Docinfo are not correctly included (#522)
• activate completion only when : is at the start of the line by @Mogztter (#529)
• correctly pass the --footer-center option to wkthtmltopdf by @gurbindersingh (#526)
• fix asciidoctor-pdf and wkhtmltopdf user settings by @meznom (#533)
• set CSS variables for font size, font family and line height by @Mogztter (#530)
• fix format of paste image default filename by @Zhou-Yicheng (#558)
• show source action does not open a new pane (if the source is already opened) by @marieflorescontact (#562)
• fix for opening links to local files in preview window by @tombolano & @marieflorescontact (#572 #573)
• fix the logic that detects if asciidoctor-pdf and/or bundler are available in the PATH
• fix base directory when...

v3.0.6

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: v3.0.5...v3.0.6

v3.0.5

What's Changed

Changelog

Breaking changes

• use vscode fs api instead of Node fs by @apupier in #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

• Include path to completion item for xref by @apupier in #671
• add ability for asciidocParser to pass the krokiServerUrl by @haydencbarnes in #701
• provide completion short hand and long hand notation with similar scope of legacy by @apupier in #668
• append AsciiDoc attributes defined in antora.yml by @ggrossetie in #694
• add UI message with Japanese locale by @YoshihideShirai in #689
• support non-Git workspace by @ggrossetie in #696
• provide completion after<<from same document by @apupier in #670

Bug fixes

• Fix completion after xref: for old double-square bracket notation by @apupier in #667

New Contributors

• @haydencbarnes made their first contribution in #701

Release meta

Released by: @ggrossetie

Full Changelog: v3.0.4...v3.0.5

v3.0.3

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: v3.0.2...v3.0.3

v3.0.2

What's Changed

Changelog

Improvements

• support .asciidoctorconfig and .asciidoctorconfig.adoc by @apupier, @mogztter and @ahus1 (#380)
• initial support for Antora by @marieflorescontact
• resolve Antora resources IDs on images by @marieflorescontact in #614
• add an option to preserve the preview window to avoid refreshing when switching away, and added setting to control this behavior by @rben01 in #607
• simplify contributions and add editor-selection style
• add support for custom templates by @xdavidson in #616
• provide sorttext on include suggestions by @eiswind in #626
• search path for included files by @eiswind in #618
• add drop images into editor feature by @marieflorescontact in #627
• set env attribute to vscode by @Mogztter in #644
• open xref from preview by @Mogztter in #643

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

• fix release automation
• fix autocompletion on files (by replacing .md by .adoc)
• allow loading local resources from all workspace folders
• fix extensions loading on Windows (using fsPath otherwise Node require doesn't work on Windows) #630
• fix show preview/preview localization by @Mogztter in #640

Infrastructure

• Improve pull request and issue templates by @Mogztter in #633
• Add renovate config by @Mogztter in #657

Documentation

• Fix 2 small typos in readme by @apupier in #642
• Add an introduction and a prerequisite section. by @ahus1 in #656

New Contributors

• @xdavidson made their first contribution in #616
• @eiswind made their first contribution in #626
• @ahus1 made their first contribution in #656

Release meta

Released by: @Mogztter

Full Changelog: v3.0.1...v3.0.2