3.0.1

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: v3.0.0...v3.0.1

v3.0.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.

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)

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)

Infrastructure

• upgrade dependencies (#515)
• extract the report errors logic into a dedicated function by @Mogztter (#534)
• extract get baseDir logic by @Mogztter (#535)
• remove superfluous copycss by @Mogztter (#538)
• unwrap convertUsingJavascript function by @Mogztter (#537)
• introduce a load function by @Mogztter (#541)
• remove slugifier (unused) from AsciidocEngine by @Mogztter (#545)
• introduce an export function by @Mogztter (#546)

Documentation

• add basic instructions on how to develop/test the extension by @danyill (#540)
• fix manual install command in README by @marieflorescontact (#544)
• update contributing guide by @Mogztter (#554)

New Contributors

• @gurbindersingh made their first contribution in #528
• @meznom made their first contribution in #533
• @marieflorescontact made their first contribution in #544
• @Zhou-Yicheng made their first contribution in #558
• @tombolano made their first contribution in #572
• @YoshihideShirai made their first contribution in #569

Full Changelog: v2.9.8...v3.0.0

v2.9.8

What's Changed

• Set basebackend and outfilesuffix by @Mogztter in #524
• Upgrade dependencies by @Mogztter in #515
• Fix html2pdf by @gurbindersingh in #528
• Activate completion when : is at the start of the line by @Mogztter in #529
• Correctly read user setting wkhtmltopdf_path by @meznom
• Correctly read user setting asciidoctorpdf_command by @meznom

New Contributors

• @gurbindersingh made their first contribution in #528
• @meznom

Full Changelog: v2.9.5...v2.9.8

v2.9.5

What's Changed

• Fix regression in the PDF export by @Mogztter in #512
• Reduce bundle size by @Mogztter in #517
• Register the custom converter as webview-html5 by @Mogztter in #513

Full Changelog: v2.9.4...v2.9.5

v2.9.4

What's Changed

• Remove unused json-schema by @Mogztter in #503
• Fix regression in default preview styling by @danyill in #510
• Upgrade Asciidoctor.js to 2.2.6 by @Mogztter in #514

Full Changelog: v2.9.3...v2.9.4

v2.9.3

What's Changed

• Build the web extension when packaging by @Mogztter in #500

Full Changelog: v2.9.2...v2.9.3

v2.9.2

What's Changed

• Enable tests by @Mogztter in #495
• Add link provider for includes, closes #99 by @danyill in #494
• Bump follow-redirects from 1.14.2 to 1.14.7 by @dependabot in #485
• Scroll to the first line when the preview hits top by @Mogztter in #475
• Removed a double word, add some colons for clarity, and puctuation. by @thepollard in #483
• Initial work to make the extension available as a Web Extension by @Mogztter in #473

New Contributors

• @thepollard made their first contribution in #483

Full Changelog: v2.8.10...v2.9.2

v2.8.10

• Ensure Asciidoctor.js error reporting is displayed on Windows (closes #466)
• Provide offline and integrated code syntax highlighting with highlight.js (closes #459)
• Update preview on preferences change (closes #447)
• Enforce code style (closes #446)
• Make use_kroki setting change effective without VS code restart (closes #444)
• Allow links to work in the preview pane (closes #435)
• Update Asciidoctor.js to 2.2.5 (closes #431)
• Upgrade asciidoctor-kroki to allow use of pikchr diagrams (closes #419)
• Allow chapter to start from zero (closes #415)
• Fix options link in README.md (closes #405)

v2.8.9

Release

v2.8.8

Prepare release for v2.8.8