Enhancement: Support Asciidoc as the content body, similar to current Markdown support. #657

New Issue

2026-10-05T02:58:52+02:00

adam commented

2026-10-05 02:58:52 +02:00

Is your feature request related to a problem? Please describe.

I use structured data in frontmatter to define the page layout, but I have content 'blocks' in the design that use the 'body' content of the AsciiDoc file. I have linked to a simple example file below showing some frontmatter and AsciiDoc content.

Describe the solution you'd like

Do what you do for Markdown support, but for the AsciiDoc format too.

Describe alternatives you've considered

I considered just using Markdown, but it supports a minimal subset of the features in AsciiDoc that I need to use for my technical documentation content.

Additional context

AsciiDoc has a very similar syntax to Markdown.

You can use asciidoctor.js for content preview.

Example file with a single design block defined in the front matter called 'content', that injects the AsciiDoc content below front matter into that part of the page. Here is the final rendering of that page on the site. https://www.thegooddocsproject.dev/about

**Is your feature request related to a problem? Please describe.** I use structured data in frontmatter to define the page layout, but I have content 'blocks' in the design that use the 'body' content of the AsciiDoc file. I have linked to a simple example file below showing some frontmatter and AsciiDoc content. **Describe the solution you'd like** Do what you do for Markdown support, but for the AsciiDoc format too. **Describe alternatives you've considered** I considered just using Markdown, but it supports a minimal subset of the features in AsciiDoc that I need to use for my technical documentation content. **Additional context** [AsciiDoc has a very similar syntax to Markdown](https://docs.asciidoctor.org/asciidoc/latest/asciidoc-vs-markdown/). You can use [asciidoctor.js](https://docs.asciidoctor.org/asciidoctor.js/latest/) for content preview. [Example file](https://gitlab.com/tgdp/www/-/blob/main/src/content/about.adoc?ref_type=heads&plain=1) with a single design block defined in the front matter called 'content', that injects the AsciiDoc content below front matter into that part of the page. Here is the final rendering of that page on the site. https://www.thegooddocsproject.dev/about

adam closed this issue

2026-10-05 02:58:52 +02:00

adam commented

2026-10-05 02:58:53 +02:00

Thanks @zivbk1 for this suggestion, I'll take a look into it.

Thanks @zivbk1 for this suggestion, I'll take a look into it.

adam commented

2026-10-05 02:58:53 +02:00

This will be helpful for at least 3 projects I am working on now that have migrated from Markdown to AsciiDoc for long-form content.

This will be helpful for at least 3 projects I am working on now that have migrated from Markdown to AsciiDoc for long-form content.

adam commented

2026-10-05 02:58:54 +02:00

I looked into it and tried to see what is possible with FM without any code change. In my test project, I used the following configuration:

{
  "$schema": "https://beta.frontmatter.codes/frontmatter.schema.json",
  "frontMatter.content.supportedFileTypes": [
    "md",
    "mdx",
    "markdown",
    "adoc"
  ],
  "frontMatter.content.pageFolders": [{
    "title": "AsciiDoc",
    "path": "[[workspace]]/content/asciidoc",
    "contentTypes": ["AsciiDoc"]
  }],
  "frontMatter.taxonomy.contentTypes": [{
    "name": "AsciiDoc",
    "pageBundle": false,
    "fileType": "adoc",
    "fields": [{
        "title": "Default title",
        "name": "title",
        "type": "string"
      },
      {
        "title": "Layout",
        "name": "layout",
        "type": "string"
      },
      {
        "title": "Blocks",
        "name": "blocks",
        "type": "block",
        "fieldGroup": [
          "AsciiDoc"
        ]
      }
    ]
  }],
  "frontMatter.taxonomy.fieldGroups": [{
    "id": "AsciiDoc",
    "labelField": "title",
    "fields": [{
        "title": "Title",
        "name": "title",
        "type": "string",
        "single": true
      },
      {
        "title": "Block ref",
        "name": "block_ref",
        "type": "string",
        "single": true
      }
    ]
  }]
}

This allows you to change the front matter in your adoc file.

What are exactly the improvements you are looking for that FM needs to support for AsciiDoc?

I looked into it and tried to see what is possible with FM without any code change. In my test project, I used the following configuration: ```json { "$schema": "https://beta.frontmatter.codes/frontmatter.schema.json", "frontMatter.content.supportedFileTypes": [ "md", "mdx", "markdown", "adoc" ], "frontMatter.content.pageFolders": [{ "title": "AsciiDoc", "path": "[[workspace]]/content/asciidoc", "contentTypes": ["AsciiDoc"] }], "frontMatter.taxonomy.contentTypes": [{ "name": "AsciiDoc", "pageBundle": false, "fileType": "adoc", "fields": [{ "title": "Default title", "name": "title", "type": "string" }, { "title": "Layout", "name": "layout", "type": "string" }, { "title": "Blocks", "name": "blocks", "type": "block", "fieldGroup": [ "AsciiDoc" ] } ] }], "frontMatter.taxonomy.fieldGroups": [{ "id": "AsciiDoc", "labelField": "title", "fields": [{ "title": "Title", "name": "title", "type": "string", "single": true }, { "title": "Block ref", "name": "block_ref", "type": "string", "single": true } ] }] } ``` This allows you to change the front matter in your `adoc` file. ![image](https://github.com/user-attachments/assets/fdca7fba-727c-41f9-af32-69dca450a810) What are exactly the improvements you are looking for that FM needs to support for AsciiDoc?

adam commented

2026-10-05 02:58:55 +02:00

This is great! I think the only part missing now would be the WYSIWYG tools for things like headings, links, images, bold, italics, etc. that used slightly different syntax than Markdown. The hope is an equivalent editing experience, with snippets and all the other good stuff.

https://frontmatter.codes/docs/markdown

This is great! I think the only part missing now would be the WYSIWYG tools for things like headings, links, images, bold, italics, etc. that used slightly different syntax than Markdown. The hope is an equivalent editing experience, with snippets and all the other good stuff. https://frontmatter.codes/docs/markdown

adam commented

2026-10-05 02:58:56 +02:00

@bwklein I have included support for Asciidocs. When you add adoc to the supported file types, the WYSIWYG tools become available and their markers have been updated to match the Asciidoc markup.

Give it a try in the latest beta and let me know if anything needs to be changed.

@bwklein I have included support for Asciidocs. When you add `adoc` to the supported file types, the WYSIWYG tools become available and their markers have been updated to match the Asciidoc markup. Give it a try in the latest beta and let me know if anything needs to be changed.

adam commented

2026-10-05 02:58:56 +02:00

You are awesome! I am going to try this today on a new project.

You are awesome! I am going to try this today on a new project.

adam commented

2026-10-05 02:58:57 +02:00

Trying it out and have some feedback.

When I click the 'Other markup options' button I see a list like this.

It looks like labels and details are missing from various commands.

Trying it out and have some feedback. When I click the 'Other markup options' button I see a list like this. ![image](https://github.com/user-attachments/assets/16e835e0-4a26-40a3-944a-cd2b1de0d6ff) It looks like labels and details are missing from various commands.

adam commented

2026-10-05 02:58:58 +02:00

Would be nice to have the Framework id of SvelteKit built-in.

Would be nice to have the Framework id of SvelteKit built-in.

adam commented

2026-10-05 02:58:58 +02:00

Support the following features for adoc.

frontMatter.content.fmHighlight
frontMatter.content.hideFm
frontMatter.content.hideFmMessage

Support the following features for adoc. - frontMatter.content.fmHighlight - frontMatter.content.hideFm - frontMatter.content.hideFmMessage

adam commented

2026-10-05 02:58:59 +02:00

It looks like labels and details are missing from various commands.

Will check what is going on here. It seems the localization functionality isn't working.

> It looks like labels and details are missing from various commands. Will check what is going on here. It seems the localization functionality isn't working.

adam commented

2026-10-05 02:59:00 +02:00

@bwklein the localization issue should have been fixed in the latest beta version.

@bwklein the localization issue should have been fixed in the latest beta version.

adam commented

2026-10-05 02:59:01 +02:00

@estruyf I think the image tool should use the image block macro instead of the inline image macro.

https://docs.asciidoctor.org/asciidoc/latest/macros/images/

@estruyf I think the image tool should use the image block macro instead of the inline image macro. https://docs.asciidoctor.org/asciidoc/latest/macros/images/

adam commented

2026-10-05 02:59:01 +02:00

@zivbk1 that is using two :: instead of one : ?

@zivbk1 that is using two `::` instead of one `:` ?

adam commented

2026-10-05 02:59:02 +02:00

Yes, the second colon tells the compiler to make a 'block' instead of an 'inline' image.

Yes, the second colon tells the compiler to make a 'block' instead of an 'inline' image.

adam commented

2026-10-05 02:59:02 +02:00

Support the following features for adoc.

frontMatter.content.fmHighlight
frontMatter.content.hideFm
frontMatter.content.hideFmMessage

When you add adoc to the supported file types, it should automatically use these features.

> Support the following features for adoc. > > frontMatter.content.fmHighlight > frontMatter.content.hideFm > frontMatter.content.hideFmMessage When you add `adoc` to the supported file types, it should automatically use these features. ![image](https://github.com/user-attachments/assets/3cf70f83-ac33-4317-9b1b-79fbfa3ea0c1) ![image](https://github.com/user-attachments/assets/ff4a43bb-5aef-4325-bbe4-c085589933be)

adam commented

2026-10-05 02:59:03 +02:00

This functionality is now part of the v10.4.0 main release.

This functionality is now part of the `v10.4.0` main release.

Sign in to join this conversation.

main

beta

dependabot/npm_and_yarn/js-yaml-4.3.1

dependabot/npm_and_yarn/multi-7958ac4c45

dependabot/npm_and_yarn/postcss-8.5.25

dependabot/npm_and_yarn/multi-670d462a53

dependabot/npm_and_yarn/http-proxy-middleware-2.0.10

dependabot/npm_and_yarn/shell-quote-1.10.0

dependabot/npm_and_yarn/websocket-driver-0.7.5

dependabot/npm_and_yarn/multi-6aaed2ab8e

copilot/validate-issue-1043

dependabot/npm_and_yarn/multi-84120a5570

dependabot/npm_and_yarn/launch-editor-2.14.1

dependabot/npm_and_yarn/multi-9dd3b9b346

estruyf/smart-file-rename

copilot/fix-unwanted-auto-update-publish-date

copilot/fix-content-view-sorting-issue

copilot/fix-virtual-workspace-folder-selection

copilot/fix-937

copilot/fix-965

copilot/fix-958

copilot/fix-950

copilot/fix-932

copilot-integration

hotfix/10.2.1

issue/816

issue/671

i18n

azure-translator

issue/747

issue/673

poc/content-tagging

combobox

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: adam/vscode-front-matter#657