v1.0.0-beta.1: Asciidoctor

⚠️ BREAKING CHANGE:

With this beta release, Antmarky has undergone major refactoring to support Asciidoctor, and consequently drop Markdown support completely.

Why making this switch? Well, there are plenty of reasons. Check my article "Stop Using Markdown For Documentation" for more context.

---

From now on, you can copy the content of code blocks by clicking the clipboard icon that appears in the upper-right, next to the language badge:

Under the hood, Antmarky now uses Jest (instead of Mocha) as the main test framework.

Full Changelog

v0.10.0: CI tagged releases

This is another maintenance release to improve CI release processes.

From now on, you can use tagged docker images (not only latest) that correspond to specific release version.
Docker Hub description gets updated on each tagged release as well.

Another improvement is auto-creation of GitHub releases on each tag push that will help you to get information on new updates faster.

Bug fixes:

• Updated bump-version script to push lightweight tags

Full changelog

v0.9.0: conventional changelog

This is mostly a maintenance release related to internal processes. However, these updates will help keeping the project in a better shape.

The foremost update is a full switch to conventional commits and semantic versioning to:

• make commit history clean and consistent
• make software updates more predictable
• ensure that project state is in sync with versioning
• generate changelogs automatically

The project now also features a linter to enforce coding standards.

---

Bug fixes:

• resolved broken alignment of expandable directories in mobile resolutions

Full changelog

v0.8.0: syntax deprecation, new admonitions

⚠️ BREAKING CHANGE:

Antmarky no longer supports special Markdown syntax to handle <sub> and <sup> tags. You can use
the corresponding HTML tags instead.

---

From now on, you can use new types of admonitions: example and quote. Furthermore, all the admonitions received new styling and icons.

Bug fixes:

• Resolved the issue with fonts and styles that were not properly loaded after the build command

Full changelog

v0.7.0: directory tree search, sidebars, anchors, and scroll-spy

From now on, Antmarky goes through all the child folders inside the documentation directory to search for Markdown files.

This release also brings important visual updates:

• sidebars are now remain fixed when scrolling content
• you can now get a link to the specific heading by clicking the anchor (hashtag) next to it
• table of contents now highlights the heading you are currently reading

Full changelog

v0.6.0: labels for code blocks

From now on, each code block features a label indicating the language used inside the block. If the language is not set, text will be used as the default value.

Process improvement: when you create a pull request related to documentation, you can preview your changes to check if everything looks nice and smooth. The link to the preview environment is available in the Checks panel.

Full changelog

v.0.5.0: embed remote markdown files

With this update, you can embed content from remote markdown files located in GitHub or BitBucket via !!+ <link_to_remote_md_file>.

For more details about this feature, please refer to the documentation.

Full changelog

v0.4.0: docker image for serve and build commands

From now on, you can use Docker container with Antmarky to serve and build your static files on-the-fly.

Full changelog

v0.3.0: toc styling and responsive layout

This release brings several important visual updates:

• table of contents now respects the heading levels and indents them accordingly
• fully-responsive layout for tablets and mobiles

and also addresses several bug fixes:

• correct multiline content support in admonitions
• pass proper data to render 404 page

Full changelog

v0.2.0: add support of default docs directory

This release allows you to pass serve and build commands without specifying a directory.
In this case, the <project>/docs directory will be used by default.

Full changelog