gradle / gradle/exemplar

Discover and verify samples embedded in Markdown

Open
#25 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Java
Stars
36
Forks
13
Avg merge
7h 36m
Merged PRs (30d)
4

Description

[remark](https://github.com/remarkjs/remark) seems like it may be capable of extracting what we need from Markdown documents and executing samples.

Given that markdown is more widely used than Asciidoctor, this may greatly increase the possible user base of this library.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by evaluating the linked remark project for Markdown sample extraction and execution capabilities. Define how embedded samples should be discovered and verified, and confirm that completion means Markdown documents can be processed with the same sample-verification goal described for this library.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.