Skip to content

Add Markdown backend for Asciidoctor docs #2340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
leonard84 wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Add Markdown backend for Asciidoctor docs #2340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
561aa5c
Add skeleton MarkdownConverter with SPI registration and core dispatch
leonard84 Apr 8, 2026
a3246d2
Implement all MarkdownConverter node type methods
leonard84 Apr 8, 2026
d1d5cb9
Skip IncludedSourceLinker table wrapping for markdown backend
leonard84 Apr 8, 2026
d451233
Add markdown backend to asciidoctor task and include in publishDocs
leonard84 Apr 8, 2026
e1c3577
Fix HTML entity decoding, double-nested links, and output paths
leonard84 Apr 8, 2026
e0e6924
Split into separate asciidoctor tasks to skip diagrams for markdown
leonard84 Apr 8, 2026
1cb9340
Fix lost emphasis text in list items and add missing node types
leonard84 Apr 8, 2026
d41533b
Fix inline_break handling to preserve text before + continuation
leonard84 Apr 8, 2026
4058ea7
DRY MarkdownConverter with shared helper methods
leonard84 Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/docs-pr.main.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ workflow(
"./gradlew",
"--stacktrace",
"asciidoctor",
"asciidoctorMarkdown",
"javadoc",
""""-Dvariant=${Matrix.axes.variants.last()}"""",
""""-DjavaVersion=${Matrix.axes.javaVersions.last()}""""
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs-pr.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ jobs:
run: 'sudo apt update && sudo apt install --yes graphviz'
- id: 'step-3'
name: 'Build Docs'
run: './gradlew --stacktrace asciidoctor javadoc "-Dvariant=5.0" "-DjavaVersion=25"'
run: './gradlew --stacktrace asciidoctor asciidoctorMarkdown javadoc "-Dvariant=5.0" "-DjavaVersion=25"'
- id: 'step-4'
name: 'Archive and upload docs'
uses: 'actions/upload-artifact@v7'
Expand Down
5 changes: 5 additions & 0 deletions ...extensions/src/main/java/org/spockframework/plugins/asciidoctor/IncludedSourceLinker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -604,6 +604,11 @@ private void processBlocks(Document document, boolean listings) {
lines.removeIf(line -> line.trim().startsWith(includeSourceMarker) && line.endsWith(includeSourceMarker));
block.setLines(lines);

// For markdown backend, skip the table wrapping — just keep the plain code block
if ("markdown".equals(document.getAttribute("backend"))) {
return;
}

// construct an AsciiDoc table programmatically that wraps
// the current block and in AsciiDoc would be looking like
//
Expand Down
Loading
Loading